chore: switch to `uv` and `nox` #143

2bndy5 · 2025-05-30T21:39:27Z

Use uv to manage dependencies
Updated dependabot config to use uv.lock file
Remove requirements*.txt in favor of uv.lock
Use nox as the project task runner
Updated CI to use uv and nox
Add CONTRIBUTING doc about on-boarding info
Update RTD config

Summary by CodeRabbit

New Features
- Added a comprehensive contributor guide outlining setup, testing, and documentation instructions.
- Introduced automation scripts to streamline development tasks, testing, and documentation building.
Improvements
- Switched environment and dependency management to use the uv tool across development, testing, and documentation workflows.
- Simplified and clarified project dependencies and development tools configuration.
- Enhanced documentation with new navigation and theme options.
- Refined GitHub Actions workflows for building documentation, running tests, and generating coverage reports.
- Updated documentation build and hosting processes for better integration and automation.
- Enforced consistent line endings for YAML and TOML files.
Removals
- Deleted legacy requirements and development dependency files in favor of centralized configuration.
Documentation
- Integrated contributing guidelines directly into the documentation navigation.

- Use `uv` to manage dependencies - Remove requirements*.txt in favor of uv.lock - Updated dependabot config to use uv.lock file - Use `nox` as the project task runner - Updated CI to use `uv` and `nox` - Add CONTRIBUTING doc about on-boarding info - Update RTD config

skip building libgit2

codecov · 2025-05-31T00:03:41Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.25%. Comparing base (f01a6b1) to head (bab6473).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##              main     #143      +/-   ##
===========================================
- Coverage   100.00%   98.25%   -1.75%     
===========================================
  Files           24       23       -1     
  Lines         1869     1886      +17     
===========================================
- Hits          1869     1853      -16     
- Misses           0       33      +33

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

2bndy5 · 2025-05-31T00:09:07Z

Well, coverage went down for some reason; I'll investigate that.

I had a lot of trouble testing pre-release python on Windows (& some Linux) runners. So, I've disable using pre-releases for now.

Test in CI are now done with fewer jobs. Each clang version gets its own job per platform. Each test jobs uses all supported stable versions of Python. Over all, this approach takes ~5 min less CI time and uses much less CI artifacts.

I think this also fixes the problem we had before uploading coverage reports. But I'm not using the reusable workflow for that anymore.

coderabbitai · 2025-05-31T00:15:43Z

Note

Reviews paused

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Walkthrough

This update restructures the project's dependency management and automation workflows. It removes requirements.txt and requirements-dev.txt in favor of explicit dependency declarations in pyproject.toml and introduces dependency groups. Development automation is migrated to a new noxfile.py using the uv tool. Continuous integration workflows are revised to use uv and Nox, with jobs rewritten for clarity and efficiency. Documentation build and contribution guidelines are updated accordingly.

Changes

File(s)	Change Summary
`.gitattributes`	Updated to normalize line endings for `.yml`, `.yaml`, and `.toml` files (with a typo for `.yaml`).
`.github/dependabot.yml`	Changed package ecosystem from `pip` to `uv` and renamed group accordingly.
`.github/workflows/build-docs.yml`	Replaced reusable workflow with explicit steps using `uv` and Nox for documentation build and deployment.
`.github/workflows/run-dev-tests.yml`	Removed separate build job, simplified test matrix, switched to `uv` and Nox, and made coverage reporting explicit.
`.gitpod.yml`	Switched environment setup from `pip` to `uv` commands for dependency sync and pre-commit installation.
`.readthedocs.yaml`	Replaced Sphinx builder config with custom job-based build using `uv` and Nox.
`CONTRIBUTING.rst`	New file with setup and contribution instructions using `uv` and Nox.
`docs/conf.py`	Added Sphinx extension for inline icons and a new palette for theme options.
`docs/contributing.rst`	Now includes the main `CONTRIBUTING.rst` file.
`docs/index.rst`	Added "contributing" to hidden toctree for documentation navigation.
`docs/requirements.txt`	Removed the only dependency (`sphinx-immaterial`).
`noxfile.py`	New file defining sessions for docs, test, test-all, and coverage using `uv` and Nox.
`pyproject.toml`	Declared all dependencies explicitly, introduced dependency groups, and updated coverage config.
`requirements-dev.txt`, `requirements.txt`	Deleted; dependencies now managed through `pyproject.toml` and dependency groups.

Sequence Diagram(s)

CI Test Workflow (New)

sequenceDiagram
    participant GitHub Actions
    participant uv
    participant Nox
    participant pytest
    participant Coverage

    GitHub Actions->>uv: Install and sync dependencies (test group)
    GitHub Actions->>Nox: Run test-all session
    Nox->>pytest: Execute tests with coverage
    pytest->>Coverage: Generate coverage data
    GitHub Actions->>Nox: Run coverage session
    Nox->>Coverage: Combine and report coverage
    GitHub Actions->>Codecov: Upload coverage data

Documentation Build and Deploy (New)

sequenceDiagram
    participant GitHub Actions
    participant uv
    participant Nox
    participant Sphinx
    participant GitHub Pages

    GitHub Actions->>uv: Install and sync dependencies (docs group)
    GitHub Actions->>Nox: Run docs session
    Nox->>Sphinx: Build HTML documentation
    GitHub Actions->>GitHub Pages: Deploy docs if on main branch

Local Development Setup (from CONTRIBUTING.rst)

sequenceDiagram
    participant Developer
    participant uv
    participant pre-commit
    participant Nox

    Developer->>uv: Run uv sync to create venv and install dev dependencies
    Developer->>uv: Run pre-commit install
    Developer->>uv: Run nox -s test or nox -s docs
    uv->>Nox: Execute test/docs session

Suggested labels

enhancement

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

.github/workflows/build-docs.yml

.github/workflows/run-dev-tests.yml

.readthedocs.yaml

noxfile.py

shenxianpeng

All goood.

call `uv` directly when using it use fixed install path

2bndy5 · 2025-05-31T04:24:19Z

@coderabbitai pause

CI run only tests that need to be repeated for each version of clang. 1 job tests everything

tests/capture_tools_output/test_tools_output.py

2bndy5 · 2025-06-12T02:10:38Z

I don't understand the loss of coverage. I run the tests locally and some lines are covered but not covered in CI. I also see lines missing coverage in both CI and local results, but these lines should be triggered by the current tests that are being run.

I'm giving up on the coverage investigation. I really think it is a side effect of using chdir() with multithreading. @coderabbitai resume

pyproject.toml

2bndy5 · 2025-06-12T03:04:06Z

Avoid calling os.chdir() in production code

I will pursue this idea in a separate issue. It may also be causing some other problems.

.github/workflows/run-dev-tests.yml

2bndy5 added 2 commits May 30, 2025 14:35

update gitpod config

bb52cf3

2bndy5 added the dependencies label May 30, 2025

github-actions bot added the documentation Improvements or additions to documentation label May 30, 2025

2bndy5 force-pushed the switch-to-uv branch 3 times, most recently from 24c51f9 to 94139f2 Compare May 30, 2025 23:02

2bndy5 added 2 commits May 30, 2025 16:20

don't test python pre-releases

e4c2e7a

skip building libgit2

adjust coverage.py config

cb7da28

2bndy5 force-pushed the switch-to-uv branch from 94139f2 to cb7da28 Compare May 30, 2025 23:20

fix coverage reporting step

52e88aa

2bndy5 force-pushed the switch-to-uv branch from 90fc0fc to 52e88aa Compare May 30, 2025 23:50

2bndy5 marked this pull request as ready for review May 31, 2025 00:09

This comment was marked as resolved.

Sign in to view

shenxianpeng reviewed May 31, 2025

View reviewed changes

.github/workflows/build-docs.yml Outdated Show resolved Hide resolved

shenxianpeng reviewed May 31, 2025

View reviewed changes

.github/workflows/run-dev-tests.yml Outdated Show resolved Hide resolved

shenxianpeng reviewed May 31, 2025

View reviewed changes

.readthedocs.yaml Outdated Show resolved Hide resolved

shenxianpeng reviewed May 31, 2025

View reviewed changes

noxfile.py Show resolved Hide resolved

shenxianpeng approved these changes May 31, 2025

View reviewed changes

This comment was marked as resolved.

Sign in to view

2bndy5 force-pushed the switch-to-uv branch from 8ed7412 to b81012c Compare May 31, 2025 03:12

2bndy5 added 3 commits May 30, 2025 20:14

AI suggestions

3737497

include clang v20 in tests

580143f

restrict codecov uploads to this repo only

c4c1dee

This comment was marked as resolved.

Sign in to view

2bndy5 force-pushed the switch-to-uv branch 2 times, most recently from 4a4024d to a56e20e Compare May 31, 2025 03:20

use curl one-liner to install uv on RTD runner

c2c2c8b

call `uv` directly when using it use fixed install path

2bndy5 force-pushed the switch-to-uv branch from c671e8d to c2c2c8b Compare May 31, 2025 03:42

This comment was marked as resolved.

Sign in to view

2bndy5 added 2 commits May 30, 2025 21:22

measure thread and multiprocessing concurrencies

b4566d3

don't exclude all of __init__.py from coverage

8f032d5

2bndy5 force-pushed the switch-to-uv branch 4 times, most recently from c09f654 to 872f3e0 Compare June 1, 2025 02:59

2bndy5 linked an issue Jun 1, 2025 that may be closed by this pull request

Probably remove if __name__ == "__main__" #142

Closed

2bndy5 mentioned this pull request Jun 1, 2025

Probably remove if __name__ == "__main__" #142

Closed

Use marks to skip tests independent of clang

2eef159

CI run only tests that need to be repeated for each version of clang. 1 job tests everything

2bndy5 force-pushed the switch-to-uv branch from 872f3e0 to 2eef159 Compare June 1, 2025 03:33

2bndy5 added 3 commits May 31, 2025 20:49

more test review

cf85a7e

show me test output in CI

cc623f2

use 1 venv for each test job

d436982

2bndy5 commented Jun 3, 2025

View reviewed changes

tests/capture_tools_output/test_tools_output.py Outdated Show resolved Hide resolved

remove unused const

b5d6e5f

This comment was marked as off-topic.

Sign in to view

2bndy5 commented Jun 12, 2025

View reviewed changes

pyproject.toml Show resolved Hide resolved

2bndy5 mentioned this pull request Jun 12, 2025

Avoid calling os.chdir() in production code #144

Open

2bndy5 commented Jun 12, 2025

View reviewed changes

.github/workflows/run-dev-tests.yml Outdated Show resolved Hide resolved

less verbose test output in CI logs

bab6473

2bndy5 merged commit cf35912 into main Jun 12, 2025
40 checks passed

2bndy5 deleted the switch-to-uv branch June 12, 2025 03:41

2bndy5 mentioned this pull request Jul 26, 2025

feat: support python 3.14 #139

Closed

coderabbitai bot mentioned this pull request Sep 4, 2025

feat: generate _version.py #150

Closed

Uh oh!

chore: switch to uv and nox #143

chore: switch to uv and nox #143

Uh oh!

Conversation

2bndy5 commented May 30, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

codecov bot commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

2bndy5 commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Sequence Diagram(s)

CI Test Workflow (New)

Documentation Build and Deploy (New)

Local Development Setup (from CONTRIBUTING.rst)

Suggested labels

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shenxianpeng left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

2bndy5 commented May 31, 2025

Uh oh!

Uh oh!

2bndy5 commented Jun 12, 2025

Uh oh!

This comment was marked as off-topic.

Uh oh!

2bndy5 commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chore: switch to `uv` and `nox` #143

chore: switch to `uv` and `nox` #143

2bndy5 commented May 30, 2025 •

edited by coderabbitai bot

Loading

codecov bot commented May 31, 2025 •

edited

Loading

2bndy5 commented May 31, 2025 •

edited

Loading

coderabbitai bot commented May 31, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

2bndy5 commented Jun 12, 2025 •

edited

Loading