ToolR 0.1.0__tar.gz

ToolR-0.1.0/.codespell.words.ignore

@@ -0,0 +1 @@
+thirdparty

ToolR-0.1.0/.coveragerc

@@ -0,0 +1,37 @@
+[run]
+branch = True
+cover_pylib = False
+parallel = True
+concurrency = multiprocessing
+
+source =
+  python/
+  tests/
+
+omit =
+  setup.py
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if False:
+    if __name__ == .__main__.:
+    if TYPE_CHECKING:
+
+omit =
+  setup.py
+
+
+ignore_errors = True

ToolR-0.1.0/.github/actions/apply-release-patch/action.yml

@@ -0,0 +1,23 @@
+name: Apply Release Patch
+description: Prepare a release of ToolR
+
+inputs:
+  release-patch-name:
+    required: true
+    description: 'Release patch to apply'
+
+
+runs:
+  using: composite
+
+  steps:
+
+    - name: Download Release Patch Artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: ${{ inputs.release-patch-name }}
+
+    - name: Apply The Release Patch
+      shell: bash
+      run: |
+        git am --committer-date-is-author-date ${{ inputs.release-patch-name }}

ToolR-0.1.0/.github/actions/configure-git/action.yml

@@ -0,0 +1,12 @@
+name: Configure Git
+description: Configure git
+
+runs:
+  using: composite
+
+  steps:
+    - name: Configure Git
+      shell: bash
+      run: |
+        git config user.name "github-actions[bot]"
+        git config user.email "github-actions[bot]@users.noreply.github.com"

ToolR-0.1.0/.github/actions/prepare-release-patch/action.yml

@@ -0,0 +1,127 @@
+name: Prepare Release
+description: Prepare a release of ToolR
+
+inputs:
+  release-version:
+    required: false
+    description: 'Release version to prepare'
+
+  release-type:
+    required: false
+    description: 'Release type to prepare'
+    default: 'dev'
+    choices:
+      - 'major'
+      - 'minor'
+      - 'patch'
+      - 'dev'
+
+outputs:
+  release-version:
+    description: 'Prepared release version'
+    value: ${{ steps.bump-version.outputs.release-version }}
+
+  release-patch-name:
+    description: 'Name of the release patch'
+    value: ${{ steps.bump-version.outputs.release-patch-name }}
+
+runs:
+  using: composite
+
+  steps:
+
+    - name: Setup Virtual Environment
+      uses: ./.github/actions/setup-virtualenv
+      with:
+        cache-prefix: prepare-release
+        python-version: "3.11"
+        uv-sync-args: "--group docs"
+
+    - name: Bump Version
+      id: bump-version
+      shell: bash
+      run: |
+        if [ -z "${{ inputs.release-version }}" ]; then
+          echo "No release version provided, bumping version based on release type: ${{ inputs.release-type }}"
+          RELEASE_VERSION=$(uv run toolr version bump --${{ inputs.release-type }} --write --check-existing-tag)
+        else
+          echo "Using provided release version: ${{ inputs.release-version }}"
+          RELEASE_VERSION=$(uv run toolr version bump ${{ inputs.release-version }} --write --check-existing-tag)
+        fi
+
+    - name: Generate changelog for GH release
+      id: git-cliff
+      uses: orhun/git-cliff-action@v4
+      with:
+        config: cliff.toml
+        args: --unreleased --strip all
+      env:
+        OUTPUT: .release-changes.md
+        GITHUB_REPO: ${{ github.repository }}
+
+    - name: Prepare GH Release changelog
+      shell: bash
+      run: |
+        tail -n +3 .release-changes.md > final-release-notes.md
+
+    - name: Upload Release Notes Artifact
+      id: upload-release-notes
+      uses: actions/upload-artifact@v4
+      with:
+        name: toolr-${{ env.RELEASE_VERSION }}-release-notes.md
+        path: final-release-notes.md
+        retention-days: 7
+        if-no-files-found: error
+
+    - name: Attest release notes artifact
+      uses: actions/attest-build-provenance@v3
+      with:
+        subject-name: toolr-${{ env.RELEASE_VERSION }}-release-notes.md
+        subject-digest: sha256:${{ steps.upload-release-notes.outputs.artifact-digest }}
+
+    - name: Update CHANGELOG.md
+      uses: orhun/git-cliff-action@v4
+      with:
+        config: cliff.toml
+        args: --verbose --unreleased --tag '${{ env.RELEASE_VERSION }}' --prepend CHANGELOG.md
+      env:
+        GITHUB_REPO: ${{ github.repository }}
+
+    - name: Show Changes Diff
+      shell: bash
+      run: |
+        git diff --color
+
+    - name: Commit changes
+      shell: bash
+      run: |
+        # Add the CHANGELOG.md file to the commit
+        git add CHANGELOG.md
+        # Run it twice so that pre-commit can fix anything that can be automatically fixed.
+        git commit -am "chore(release): Prepare for ${{ env.RELEASE_VERSION }} release" || \
+            git commit -am "chore(release): Prepare for ${{ env.RELEASE_VERSION }} release"
+
+    - name: Tag the release
+      shell: bash
+      run: |
+        git tag -a "${{ env.RELEASE_VERSION }}" -m "Release ${{ env.RELEASE_VERSION }}"
+
+    - name: Create Release Patch
+      shell: bash
+      run: |
+        git format-patch --keep-subject --binary --stdout HEAD^ > toolr-${{ env.RELEASE_VERSION }}.patch
+
+    - name: Upload Changes Diff Artifact
+      id: upload-release-patch
+      uses: actions/upload-artifact@v4
+      with:
+        name: toolr-${{ env.RELEASE_VERSION }}.patch
+        path: toolr-${{ env.RELEASE_VERSION }}.patch
+        retention-days: 7
+        if-no-files-found: error
+
+    - name: Attest release patch artifact
+      uses: actions/attest-build-provenance@v3
+      with:
+        subject-name: toolr-${{ env.RELEASE_VERSION }}.patch
+        subject-digest: sha256:${{ steps.upload-release-patch.outputs.artifact-digest }}

ToolR-0.1.0/.github/actions/setup-pre-commit/action.yml

@@ -0,0 +1,54 @@
+name: setup-pre-commit
+description: Setup 'pre-commit'
+
+inputs:
+  version:
+    description: Pre-commit version to install
+    required: true
+    default: 3.0.3
+  cache-seed:
+    required: true
+    description: Seed used to invalidate caches
+  python-version:
+    required: true
+    description: Python version to install
+    default: 3.11
+  rust-toolchain:
+    required: true
+    description: Rust toolchain to install
+    default: stable
+
+
+runs:
+  using: composite
+
+  steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - uses: actions-rust-lang/setup-rust-toolchain@v1
+      with:
+        toolchain: ${{ inputs.rust-toolchain }}
+        components: ${{ inputs.rust-components }}
+
+    - run: pip install pre-commit
+      shell: bash
+
+    - id: python-version-checksum
+      run: echo "version-sha256sum=$(python --version --version | sha256sum | cut -d ' ' -f1)" >> "$GITHUB_OUTPUT"
+      shell: bash
+
+    - id: pre-commit-version-checksum
+      run: echo "version-sha256sum=$(pre-commit --version | sha256sum | cut -d ' ' -f1)" >> "$GITHUB_OUTPUT"
+      shell: bash
+
+    - uses: actions/cache@v4
+      with:
+        path: ${{ env.PRE_COMMIT_HOME }}
+        key: >-
+          precommit|${{ inputs.cache-seed }}|${{ runner.os }}|${{ steps.python-version-checksum.outputs.version-sha256sum }}|${{ steps.pre-commit-version-checksum.outputs.version-sha256sum }}|${{ hashFiles('**/uv.lock') }}
+      shell: bash
+
+    - run: pre-commit install --install-hooks
+      shell: bash

ToolR-0.1.0/.github/actions/setup-virtualenv/action.yml

@@ -0,0 +1,79 @@
+name: Setup UV
+description: Setup UV for a given Python version
+
+inputs:
+  python-version:
+    required: true
+    description: 'Python version to use'
+
+  cache-prefix:
+    required: true
+    description: "The prefix to use for the cache key"
+
+  uv-version:
+    default: ""
+    description: "The version of uv to install e.g., `0.5.0` Defaults to the version in pyproject.toml or 'latest'."
+
+  uv-sync-args:
+    default: "--all-extras --dev"
+    description: "The arguments to pass to the uv sync command. e.g., `--group docs` or `--dev`"
+
+outputs:
+  uv-version:
+    description: "The version of uv installed"
+    value: ${{ steps.install-uv.outputs.uv-version }}
+
+  python-version-checksum:
+    description: "The checksum of the Python version"
+    value: ${{ steps.python-version-checksum.outputs.version-sha256sum }}
+
+  uv-version-checksum:
+    description: "The checksum of the UV version"
+    value: ${{ steps.uv-version-checksum.outputs.version-sha256sum }}
+
+runs:
+  using: composite
+  steps:
+    - name: Install Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Get Python version checksum
+      id: python-version-checksum
+      shell: bash
+      run: |
+        VERSION_SHA256SUM=$(python --version --version | sha256sum | cut -d ' ' -f 1)
+        echo "VERSION_SHA256SUM=$VERSION_SHA256SUM"
+        echo "version-sha256sum=$VERSION_SHA256SUM" >> "$GITHUB_OUTPUT"
+
+    - name: Install uv
+      id: install-uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        version: ${{ inputs.uv-version }}
+
+    - name: Get UV version checksum
+      id: uv-version-checksum
+      shell: bash
+      run: |
+        VERSION_SHA256SUM=$(uv --version | sha256sum | cut -d ' ' -f 1)
+        echo "VERSION_SHA256SUM=$VERSION_SHA256SUM"
+        echo "version-sha256sum=$VERSION_SHA256SUM" >> "$GITHUB_OUTPUT"
+
+    - name: Set up cache
+      uses: actions/cache@v4
+      with:
+        path: .venv
+        key: >-
+          venv|
+          ${{ runner.os }}|
+          ${{ inputs.cache-prefix }}|
+          ${{ steps.python-version-checksum.outputs.version-sha256sum }}|
+          ${{ steps.uv-version-checksum.outputs.version-sha256sum }}|
+          ${{ hashFiles('**/uv.lock') }}
+
+    - name: Install Python Dependencies
+      shell: bash
+      run: |
+        uv sync ${{ inputs.uv-sync-args }}

ToolR-0.1.0/.github/dependabot.yml

@@ -0,0 +1,26 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - dependencies:github-actions
+    assignees:
+      - s0undt3ch
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - dependencies:rust
+    assignees:
+      - s0undt3ch
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - dependencies:python
+    assignees:
+      - s0undt3ch

ToolR-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,76 @@
+name: Build
+
+on:
+  workflow_call:
+    inputs:
+      display-name:
+        required: true
+        type: string
+        description: 'Display name for the build job'
+      release-patch-name:
+        required: true
+        type: string
+        description: 'Release patch to apply'
+      platform-matrix:
+        required: true
+        type: string
+        description: 'Platform matrix as JSON string'
+
+jobs:
+  build:
+    name: ${{ inputs.display-name }} (${{ matrix.python }}, ${{ matrix.platform.name }})
+    runs-on: ${{ matrix.platform.os }}
+    permissions:
+      id-token: write
+      contents: read
+      attestations: write
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: ${{ fromJson(inputs.platform-matrix) }}
+        python:
+          - "cp311"
+          - "cp312"
+          - "cp313"
+
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Apply Release Patch
+        uses: ./.github/actions/apply-release-patch
+        with:
+          release-patch-name: ${{ inputs.release-patch-name }}
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+          cache-key: ${{ runner.os }}|${{ matrix.python }}|${{ matrix.platform.name }}|${{ hashFiles('**/Cargo.lock') }}
+          cache-directories: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+        if: ${{ matrix.platform.emulation }}
+        with:
+          platforms: all
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v3.1.4
+        env:
+          CIBW_ARCHS_LINUX: all
+          CIBW_BUILD: ${{ matrix.python }}-${{ matrix.platform.name }}
+
+      - name: Attest build provenance
+        uses: actions/attest-build-provenance@v3
+        with:
+          subject-path: wheelhouse/*.whl
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-wheel-${{ matrix.python }}-${{ matrix.platform.name }}
+          path: wheelhouse/*.whl

ToolR-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,247 @@
+name: CI Workflow
+
+on:
+  push:
+  pull_request:
+
+concurrency:
+  # Concurrency is defined in a way that concurrent builds against branches do
+  # not cancel previous builds.
+  # However, for every new build against the same pull request source branch,
+  # all older builds against that same branch get canceled.
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.repository }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  id-token: write
+  attestations: write
+
+env:
+  FORCE_COLOR: "1"
+  PRE_COMMIT_HOME: ${{ github.workspace }}/.cache/pre-commit
+
+jobs:
+  prepare-ci:
+    name: Prepare CI
+    runs-on: ubuntu-latest
+    outputs:
+      platform-matrix: ${{ steps.generate-build-matrix.outputs.platform-matrix }}
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup Virtual Environment
+        uses: ./.github/actions/setup-virtualenv
+        with:
+          cache-prefix: prepare-ci
+          python-version: "3.11"
+
+      - name: Generate Build Matrix
+        id: generate-build-matrix
+        run: |
+          uv run toolr ci generate-build-matrix
+
+  pre-commit:
+    name: Pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.11
+
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+          components: clippy,rustfmt
+
+      - run: pip install pre-commit
+
+      - id: python-version-checksum
+        run: echo "version-sha256sum=$(python --version --version | sha256sum | cut -d ' ' -f1)" >> "$GITHUB_OUTPUT"
+
+      - id: pre-commit-version-checksum
+        run: echo "version-sha256sum=$(pre-commit --version | sha256sum | cut -d ' ' -f1)" >> "$GITHUB_OUTPUT"
+
+      - uses: actions/cache@v4
+        with:
+          path: ${{ env.PRE_COMMIT_HOME }}
+          key: >-
+            precommit|${{ runner.os }}|${{ steps.python-version-checksum.outputs.version-sha256sum }}|${{ steps.pre-commit-version-checksum.outputs.version-sha256sum }}|${{ hashFiles('**/uv.lock') }}
+
+      - run: pre-commit install --install-hooks
+      - run: pre-commit run --all-files --show-diff-on-failure --color=always
+
+  prepare-release:
+    name: Prepare Release
+    runs-on: ubuntu-latest
+    needs:
+      - pre-commit
+    outputs:
+      release-version: ${{ steps.prepare-release.outputs.release-version }}
+      release-patch-name: ${{ steps.prepare-release.outputs.release-patch-name }}
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.11
+
+      - uses: ./.github/actions/configure-git
+      - uses: ./.github/actions/prepare-release-patch
+        id: prepare-release
+        with:
+          release-type: dev
+
+  test-linux:
+    name: Test
+    needs:
+      - pre-commit
+    uses: ./.github/workflows/test.yml
+    with:
+      os: ubuntu-latest
+      display-name: Linux
+
+  test-windows:
+    name: Test
+    needs:
+      - pre-commit
+    uses: ./.github/workflows/test.yml
+    with:
+      os: windows-latest
+      display-name: Windows
+  test-macos:
+    name: Test
+    needs:
+      - pre-commit
+    uses: ./.github/workflows/test.yml
+    with:
+      os: macos-latest
+      display-name: macOS
+
+  build-linux:
+    name: Build
+    needs:
+      - prepare-ci
+      - test-linux
+      - prepare-release
+    uses: ./.github/workflows/build.yml
+    with:
+      display-name: Linux
+      release-patch-name: ${{ needs.prepare-release.outputs.release-patch-name }}
+      platform-matrix: ${{ toJSON(fromJSON(needs.prepare-ci.outputs.platform-matrix)['linux']) }}
+
+  build-windows:
+    name: Build
+    needs:
+      - prepare-ci
+      - test-windows
+      - prepare-release
+    uses: ./.github/workflows/build.yml
+    with:
+      display-name: Windows
+      release-patch-name: ${{ needs.prepare-release.outputs.release-patch-name }}
+      platform-matrix: ${{ toJSON(fromJSON(needs.prepare-ci.outputs.platform-matrix)['windows']) }}
+
+  build-macos:
+    name: Build
+    needs:
+      - prepare-ci
+      - test-macos
+      - prepare-release
+    uses: ./.github/workflows/build.yml
+    with:
+      display-name: macOS
+      release-patch-name: ${{ needs.prepare-release.outputs.release-patch-name }}
+      platform-matrix: ${{ toJSON(fromJSON(needs.prepare-ci.outputs.platform-matrix)['macos']) }}
+
+  docs:
+    name: Publish Docs
+    runs-on: ubuntu-latest
+
+    needs:
+      - pre-commit
+      - prepare-release
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Setup Virtual Environment
+        uses: ./.github/actions/setup-virtualenv
+        with:
+          cache-prefix: docs
+          python-version: "3.11"
+          uv-sync-args: "--group docs"
+
+      - name: Apply Release Patch
+        uses: ./.github/actions/apply-release-patch
+        with:
+          release-patch-name: ${{ needs.prepare-release.outputs.release-patch-name }}
+
+      - name: Build MkDocs site
+        run: uv run mkdocs build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+
+  publish:
+    name: Publish to Test PyPI
+    needs:
+      - build-linux
+      - build-windows
+      - build-macos
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/download-artifact@v5
+        with:
+          pattern: cibw-wheel-*
+          path: dist
+          merge-multiple: true
+
+      - name: Flatten dist/ directory
+        run: |
+          ls -lah dist/
+
+      - name: Publish to Test PyPI (Trusted Publisher)
+        if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          packages-dir: dist/
+          skip-existing: true
+          verbose: true
+
+  set-pipeline-exit-status:
+    permissions:
+      actions: read
+    # This step is just so we can make github require this step, to pass checks
+    # on a pull request instead of requiring all
+    name: Set the ${{ github.workflow }} Pipeline Exit Status
+    if: always()
+    runs-on: ubuntu-latest
+    needs:
+      - pre-commit
+      - prepare-release
+      - docs
+      - publish
+    steps:
+      - uses: martialonline/workflow-status@v4
+        id: check
+      - run: echo "Workflow failed"
+        if: steps.check.outputs.status == 'failure'
+      - run: echo "Workflow was cancelled"
+        if: steps.check.outputs.status == 'cancelled'
+      - run: echo "Workflow was successful"
+        if: steps.check.outputs.status == 'success'