chore: switch to uv and nox

- Removes `just` as the default task runner in favor of `nox`.
- Uses `uv` to manage dependencies, which is also used by `nox`.
- Updated CI and docs/README accordingly.
- Removed all requirements.txt files in favor of using `uv` to lock dependencies.
- Modified dependabot config to use the new uv.lock file.
- Modified RTD config to use `uv` and `nox`.

Author: 2bndy5

.config/.readthedocs.yaml

@@ -10,15 +10,14 @@ build:
   tools:
     rust: latest
     python: latest
-
-mkdocs:
-  configuration: docs/mkdocs.yml
-
-
-# Optionally declare the Python requirements required to build your docs
-
-python:
-  install:
-    - requirements: docs/requirements.txt
-    - method: pip
-      path: docs/
+  jobs:
+    pre_create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+    build:
+      html:
+        - uvx nox -s docs-build
+    post_build:
+      - mkdir -p $READTHEDOCS_OUTPUT/html/
+      - mv docs/site $READTHEDOCS_OUTPUT/html/

.github/dependabot.yml

@@ -13,12 +13,12 @@ updates:
       actions:
         patterns:
           - "*"
-  - package-ecosystem: pip
+  - package-ecosystem: uv
     directory: /
     schedule:
       interval: "weekly"
     groups:
-      pip:
+      uv-pip:
         patterns:
           - "*"
   - package-ecosystem: cargo

.github/workflows/build-docs.yml

@@ -48,18 +48,14 @@ jobs:
         with:
           path: ~/.cargo
           key: ${{ runner.os }}-docs-cargo-${{ hashFiles('Cargo.lock') }}
-      - uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: 3.x
-          cache: 'pip'
-          cache-dependency-path: docs/requirements.txt
-      - name: Install workflow deps
-        run: |
-          pip install -r docs/requirements.txt
-          pip install --force-reinstall -v docs/
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
       - name: Build docs
         working-directory: docs
-        run: mkdocs build
+        run: uvx nox -s docs-build
       - name: Upload docs build as artifact
         uses: actions/upload-artifact@v4
         with:
@@ -84,11 +80,9 @@ jobs:
         with:
           path: ~/.cargo
           key: ${{ runner.os }}-docs-cargo-${{ hashFiles('Cargo.lock') }}
-      - name: Install just
-        uses: taiki-e/install-action@v2
-        with:
-          tool: just
-      - run: just docs-rs
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - run: uvx nox -s docs-rs
       - name: upload rustdoc build as artifact
         uses: actions/upload-artifact@v4
         with:

.github/workflows/bump-n-release.yml

@@ -12,6 +12,7 @@ on:
   workflow_dispatch:
     inputs:
       component:
+        description: The version component to increase
         type: choice
         required: true
         default: patch

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

@@ -56,8 +56,11 @@ jobs:
         with:
           python-version: 3.x
 
-      - name: Install workflow deps
-        run: python3 -m pip install meson
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
 
       # # https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages
       - name: Install ninja (Linux)
@@ -88,7 +91,7 @@ jobs:
         if: runner.os == 'Linux'
         env:
           CLANG_VERSION: '7'
-        run: just test ci
+        run: uvx nox -s test -- --profile ci
 
       - name: Install clang v8
         if: runner.os == 'Linux'
@@ -100,7 +103,7 @@ jobs:
         if: runner.os == 'Linux'
         env:
           CLANG_VERSION: '8'
-        run: just test ci
+        run: uvx nox -s test -- --profile ci
 
       - name: Install clang v9
         uses: ./.github/install-clang-action
@@ -110,7 +113,7 @@ jobs:
       - name: Collect Coverage for clang v9
         env:
           CLANG_VERSION: '9'
-        run: just test ci
+        run: uvx nox -s test -- --profile ci
 
       - name: Install clang v10
         uses: ./.github/install-clang-action
@@ -120,7 +123,7 @@ jobs:
       - name: Collect Coverage for clang v10
         env:
           CLANG_VERSION: '10'
-        run: just test ci
+        run: uvx nox -s test -- --profile ci
 
       - name: Install clang 11
         uses: ./.github/install-clang-action
@@ -130,7 +133,7 @@ jobs:
       - name: Collect Coverage for clang v11
         env:
           CLANG_VERSION: '11'
-        run: just test ci
+        run: uvx nox -s test -- --profile ci
 
       - name: Install clang 12
         uses: ./.github/install-clang-action
@@ -140,7 +143,7 @@ jobs:
       - name: Collect Coverage for clang v12
         env:
           CLANG_VERSION: '12'
-        run: just test ci
+        run: uvx nox -s test -- --profile ci
 
       - name: Install clang 13
         uses: ./.github/install-clang-action
@@ -150,7 +153,7 @@ jobs:
       - name: Collect Coverage for clang v13
         env:
           CLANG_VERSION: '13'
-        run: just test ci
+        run: uvx nox -s test -- --profile ci
 
       - name: Install clang 14
         uses: ./.github/install-clang-action
@@ -160,7 +163,7 @@ jobs:
       - name: Collect Coverage for clang v14
         env:
           CLANG_VERSION: '14'
-        run: just test ci
+        run: uvx nox -s test -- --profile ci
 
       - name: Install clang 15
         uses: ./.github/install-clang-action
@@ -170,7 +173,7 @@ jobs:
       - name: Collect Coverage for clang v15
         env:
           CLANG_VERSION: '15'
-        run: just test ci
+        run: uvx nox -s test -- --profile ci
 
       - name: Install clang 16
         uses: ./.github/install-clang-action
@@ -180,7 +183,7 @@ jobs:
       - name: Collect Coverage for clang v16
         env:
           CLANG_VERSION: '16'
-        run: just test ci
+        run: uvx nox -s test -- --profile ci
 
       - name: Install clang 17
         uses: ./.github/install-clang-action
@@ -190,7 +193,7 @@ jobs:
       - name: Collect Coverage for clang v17
         env:
           CLANG_VERSION: '17'
-        run: just test ci
+        run: uvx nox -s test -- --profile ci
 
       - name: Install clang 18
         uses: ./.github/install-clang-action
@@ -200,10 +203,10 @@ jobs:
       - name: Collect Coverage for clang v18
         env:
           CLANG_VERSION: '18'
-        run: just test all
+        run: uvx nox -s test -- --profile all
 
       - name: Generate Coverage HTML report
-        run: just pretty-cov
+        run: uvx nox -s pretty-cov
 
       - name: Upload coverage data
         uses: actions/upload-artifact@v4
@@ -214,7 +217,7 @@ jobs:
       - name: Generate Coverage lcov report
         run: |
           rm coverage.json
-          just lcov
+          uvx nox -s lcov
 
       - uses: codecov/codecov-action@v5
         with:

Cargo.lock

@@ -50,7 +50,6 @@ cpp-linter -help
 | `Cargo.toml` | Metadata about the binding's rust package (which _is not_ intended to be published to crates.io). |
 | `../../cpp_linter.pyi` | The typing stubs for the package (located in repo root). |
 | `../../pyproject.toml` | Metadata about the python package (located in repo root). |
-| `requirements-dev.txt` | The dependencies used in development (not needed for runtime/production). |
 
 Hidden files and folders are not described in the table above.
 If they are not ignored by a gitignore specification, then they should be considered

bindings/python/README.md

@@ -221,7 +221,7 @@ const MAX_RETRIES: u8 = 5;
 /// This method respects both primary and secondary rate limits.
 /// In the event where  the secondary rate limits is reached,
 /// this function will wait for a time interval specified the server and retry afterward.
-async fn send_api_request(
+pub async fn send_api_request(
     client: &Client,
     request: Request,
     rate_limit_headers: &RestApiRateLimitHeaders,

bindings/python/requirements-dev.txt

@@ -7,6 +7,7 @@ words:
   - Boolish
   - bugprone
   - chrono
+  - clippy
   - codecov
   - codspeed
   - consts
@@ -31,11 +32,13 @@ words:
   - mdbook
   - mkdocs
   - msvc
+  - mypy
   - napi
   - nextest
   - nonminimal
   - peekable
   - pkgs
+  - posargs
   - positionals
   - posix
   - preprocess
@@ -49,7 +52,11 @@ words:
   - ratelimit
   - reqwest
   - revparse
+  - rustdoc
+  - rustup
+  - sdist
   - serde
+  - Shen
   - superfences
   - tada
   - tasklist
@@ -58,6 +65,7 @@ words:
   - twemoji
   - vararg
   - venv
+  - Xianpeng
 ignorePaths:
   - .env/**
   - .venv/**

cpp-linter/src/rest_api/mod.rs

@@ -2,11 +2,10 @@
 [package]
 name = "cli-gen"
 edition = "2021"
-version = "0.0.0"
 description = "A function exposed in python that generates a CLI doc from rust source code."
 repository = "https://github.com/cpp-linter/cpp-linter-rs/tree/main/docs"
+version.workspace = true
 authors.workspace = true
-homepage.workspace = true
 license.workspace = true
 
 [dependencies]

cspell.config.yml

@@ -1,21 +1,19 @@
 # Docs
 
-This folder is only for generating the documentation.
+This folder is only for generating the documentation about CLI and runtime permissions.
 Please [visit our website][gh-pages] to see generated documentation.
 
 [gh-pages]: https://cpp-linter.github.io/cpp-linter-rs
+[uv]: https://docs.astral.sh/uv/
 
-To view the documentation locally, some software needs to be installed.
+## Build and inspect locally
 
-```shell
-pip install maturin
-cd docs
-maturin dev
-pip install -r docs/requirements.txt
-```
+To view the documentation locally, some software needs to be installed.
+This project's dependencies are managed with a tool called [`uv`][uv].
+So, [`uv`][uv] is the only software that needs to be manually installed beforehand.
 
-Then use `mkdocs` to generate the docs and open them in your browser.
+After [`uv`][uv] is installed, building (and viewing) the docs is as simple as
 
 ```shell
-mkdocs serve --open
+uvx nox -s docs -- --open
 ```

docs/Cargo.toml

@@ -5,13 +5,33 @@ build-backend = "maturin"
 [project]
 name = "cli-gen"
 description = "Generate cpp-linter CLI doc from rust src."
-version = "0.0.0"
 readme = "README.md"
 license = {text = "MIT License"}
 requires-python = ">=3.7"
 authors = [
     { name = "Brendan Doherty", email = "[email protected]" },
 ]
+classifiers = ["Private :: Do Not Upload"]
+dynamic = ["version"]
 
 [tool.maturin]
 features = ["pyo3/extension-module"]
+
+[dependency-groups]
+dev = [
+    "maturin>=1.8.6",
+    "mypy>=1.15.0",
+    "ruff>=0.11.11",
+]
+docs = [
+    "markdown-gfm-admonition==0.1.1",
+    "mkdocs==1.6.1",
+    "mkdocs-gen-files==0.5.0",
+    "mkdocs-include-markdown-plugin==7.1.5",
+    "mkdocs-material==9.6.12",
+    "pyyaml==6.0.2",
+]
+
+[tool.uv]
+default-groups = "all"
+reinstall-package = ["cli-gen"]