crc-rust 0.1.0__tar.gz

crc_rust-0.1.0/.github/ISSUE_TEMPLATE/blank.md

@@ -0,0 +1,8 @@
+---
+name: 📝 Blank Issue 
+about: Blank Issue
+title: 📝 <Insert Title>
+labels: 
+assignees: ''
+
+---

crc_rust-0.1.0/.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,78 @@
+---
+name: 🐞 Bug Report
+about: File a bug report
+title: 🐞 <Insert Title>
+labels: bug
+assignees: ''
+
+---
+
+### Checklist
+In order to improve the time, how long a bugfix does take, please make sure you address as much as possible of the following checklist.
+
+- [ ] I have reproduced the issue with at least the latest released version of \<PROJECT-NAME\>.
+- [ ] I have added references to issues that sound similar.
+
+**Tip: Adding screenshots, outputs and logs help to improve clarity.**
+
+# Summary
+<!---
+Describe the bug: A clear and concise description of what the bug is.
+-->
+
+## Reproducing the Issue
+
+Reproducibility: <pick one of> sporadic, regularly, always
+<!---
+Describe how to reproduce the bug, e.g.:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+-->
+### Steps to reproduce the behavior:
+1. <step 1>
+2. <step 2>
+3. ....
+
+## Expected Behaviour
+<!---
+Describe the expected behaviour: A clear and concise description of what you expected to happen.
+-->
+
+## Actual Behaviour
+<!---
+Describe the actual observed behaviour: A clear and concise description of what you actually to happen.
+Screenshot: If applicable, add screenshots to help explain your problem.
+-->
+
+## Root Cause (optional)
+<!---
+If known
+-->
+
+
+## Context
+<!---
+Describe the actual observed behaviour: A clear and concise description of what you observed.
+Screenshot: If applicable, add screenshots to help explain your problem.
+-->
+
+### System
+<!---
+Describe the system and the used configuration.
+-->
+**Desktop:**
+ - OS: [e.g. Linux (Fedora 35), Linux (Ubuntu 20.01), MacOs (...), Windows (...)]
+ - Python Version [e.g. Python 3.8.0]
+ - Package Version [e.g. 22]
+
+### Additional Context (optional)
+<!---
+Add any additional context about the problem here.
+-->
+
+#### Related Issues (optional)
+<!---
+Link related issues form the issue tracker here.
+-->

crc_rust-0.1.0/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,41 @@
+---
+name: 📚 Documentation
+about: Add/Improve Documentation
+title: 📚 <Insert Title>
+labels: documentation
+assignees: ''
+
+---
+
+# Summary
+<!---
+A short summary on what of what needs to be documented or updated.
+--->
+
+# Details
+<!---
+A detailed description about what kind of documentation should be added and/or updated and why.
+--->
+
+## Background & Context
+<!---
+Why should this documentation be added/updated?
+
+E.g.: Users are struggling to use this API and have repeatedly asked for some example code.
+--->
+
+## References
+<!---
+Further references to e.g. other information resources like links to specification(s), api docs etc.
+--->
+
+# Task(s)
+<!---
+A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
+
+e.g.:
+- [ ] Update documentation of XYZ
+- [ ] Bump version number
+- [ ] Update changelog
+- [ ] ...
+--->

crc_rust-0.1.0/.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,47 @@
+---
+name: ✨ Feature
+about: Add/Implement Feature
+title: ✨ <Insert Title>
+labels: feature
+assignees: ''
+
+---
+
+# Summary
+<!---
+A short description of the feature (TL;DR)
+--->
+
+# Details
+<!---
+A detailed description about what should be added, background, links, context information
+and usage example(s) of the feature.
+--->
+
+## Background & Context
+<!---
+What is the motivation for the feature?
+Assessment of the feature. Pros & cons, solutions and decisions concerning the feature (reasoning).
+--->
+
+## Examples
+<!---
+Example usage(s) of the feature.
+--->
+
+## References
+<!---
+Further references to e.g. other information resources like links to specification(s) etc.
+--->
+
+# Task(s)
+<!---
+A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
+
+e.g.:
+- [ ] Add feature XYZ
+- [ ] Bump version number
+- [ ] Update documentation
+- [ ] Update changelog
+- [ ] ...
+--->

crc_rust-0.1.0/.github/ISSUE_TEMPLATE/refactoring.md

@@ -0,0 +1,47 @@
+---
+name: 🔧 Refactoring
+about: Refactor
+title: 🔧 <Insert Title>
+labels: refactoring
+assignees: ''
+
+---
+
+# Summary
+<!---
+A short description of the planed refactoring (TL;DR)
+--->
+
+# Details
+<!---
+A detailed description about what and how it should be refactored, background, links, context information
+and example(s) of how "the refactoring should look".
+--->
+
+## Background & Context
+<!---
+What is the motivation for the refactoring?
+Assessment of the refactoring. Pros & cons, solutions and decisions concerning (reasoning) the refactoring.
+--->
+
+## Examples
+<!---
+Examples of how "the refactoring should look".
+--->
+
+## References
+<!---
+Further references to e.g. other information resources like links to specification(s) etc.
+--->
+
+# Task(s)
+<!---
+A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
+
+e.g.:
+- [ ] Implement/Refactor XYZ
+- [ ] Add tests for XYZ
+- [ ] Bump version number
+- [ ] Update changelog
+- [ ] ...
+--->

crc_rust-0.1.0/.github/ISSUE_TEMPLATE/security.md

@@ -0,0 +1,58 @@
+---
+name: 🔐 Security Issue
+about: Fix Security Issue
+title: 🔐 <Insert Title>
+labels: security
+assignees: ''
+
+---
+
+# Summary
+<!---
+A short summary of the security issue.
+--->
+
+|            |     |
+|------------|-----|
+| Class/Type | -   |
+| Version(s) | -   |
+| Severity   | -   |
+| CVE Number | -   |
+
+<!---
+A quick table based overview, containing the most important details.
+
+Class/Type: Of vulnerability, e.g. xss, buffer-overflow, ... (see https://cwe.mitre.org/
+Versions: Affected software versions
+Severity: Of the vulnerability (Low, Medium, High, Critical)
+CVE Number: number and link to the cve if available
+-->
+
+
+# Details
+
+### Description
+<!---
+If no detailed information is available through references or CVE, an extensive
+description of the vulnerability should be added here.
+--->
+
+### Impact
+<!---
+Describe the impact of the vulnerability.
+--->
+
+### References
+<!---
+Links to related issues or other sources like link to CVE.
+--->
+
+# Solutions
+<!--
+Describe possible solution(s), how to address this issue.
+--->
+
+# Credit
+<!--
+Whom to thank, kudos for the reporter(s)
+-->

crc_rust-0.1.0/.github/actions/python-environment/action.yml

@@ -0,0 +1,23 @@
+name: 'SPE'
+description: 'Setup python environment'
+
+inputs:
+
+  python-version:
+    description: 'Python version to use'
+    required: true
+    default: "3.12"
+
+runs:
+
+  using: "composite"
+  steps:
+
+    - name: Install uv and set the python version
+      uses: astral-sh/setup-uv@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: uv sync
+      run: uv sync
+      shell: bash

crc_rust-0.1.0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 5
+

crc_rust-0.1.0/.github/workflows/checks.yml

@@ -0,0 +1,111 @@
+name: Checks
+
+on: workflow_call
+
+jobs:
+
+  format-job:
+    name: "Format (Python-${{ matrix.python-version }} on ${{ matrix.os }})"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os:
+          - ubuntu-latest
+        python-version:
+          - "3.12"
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python Environment
+        uses: ./.github/actions/python-environment
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Coverage
+        run: uv run invoke check.format
+
+  typing-job:
+
+    name: "Typing (Python-${{ matrix.python-version }} on ${{ matrix.os }})"
+    needs: [format-job]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os:
+          - ubuntu-latest
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python Environment
+        uses: ./.github/actions/python-environment
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Coverage
+        run: uv run invoke check.typing --files src/
+
+  linting-job:
+
+    name: "Lint (Python-${{ matrix.python-version }} on ${{ matrix.os }})"
+    needs: [format-job]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os:
+          - ubuntu-latest
+        python-version:
+          - "3.12"
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python Environment
+        uses: ./.github/actions/python-environment
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Linter
+        run: uv run invoke check.lint --files src/
+
+  tests-job:
+
+    name: "Tests (Python-${{ matrix.python-version }} on ${{ matrix.os }})"
+    needs: [format-job, linting-job, typing-job]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python Environment
+        uses: ./.github/actions/python-environment
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Tests
+        run: uv run invoke test.coverage

crc_rust-0.1.0/.github/workflows/ci-cd.yml

@@ -0,0 +1,64 @@
+name: CI/CD
+
+on:
+  push:
+    tags:
+      - '**'
+
+jobs:
+
+  check-tag-version-job:
+
+    name: Check Tag Version
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python Environment
+        uses: ./.github/actions/python-environment
+
+      - name: Check Tag Version
+        # make sure the pushed/created tag matched the project version
+        run: "[[ `uv run hatch version` == ${{ github.ref_name }} ]]"
+
+  ci-job:
+    name: Checks
+    needs: [ check-tag-version-job ]
+    uses: ./.github/workflows/checks.yml
+
+  publish-docs-job:
+    name: Publish Documentation
+    needs: [ ci-job ]
+    uses: ./.github/workflows/gh-pages.yml
+
+  cd-job:
+    name: Continues Delivery
+    needs: [ ci-job ]
+
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: SCM Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python Environment
+        uses: ./.github/actions/python-environment
+
+      - name: Build Artifacts
+        run: uv build
+
+      - name: PyPi Release
+        env:
+          UV_PUBLISH_USERNAME: "__token__"
+          UV_PUBLISH_PASSWORD: "${{ secrets.PYPI_TOKEN }}"
+        run: uv publish
+
+      - name: GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: >
+          gh release create ${GITHUB_REF_NAME}
+          --title ${GITHUB_REF_NAME} --notes-file docs/docs/changelog/changes_${GITHUB_REF_NAME}.md
+          dist/*

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

@@ -0,0 +1,10 @@
+name: CI
+
+on:
+  pull_request:
+
+jobs:
+
+  ci-job:
+    name: Checks
+    uses: ./.github/workflows/checks.yml

crc_rust-0.1.0/.github/workflows/gh-pages.yml

@@ -0,0 +1,32 @@
+name: Publish Documentation
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+
+  documentation-job:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python Environment
+        uses: ./.github/actions/python-environment
+        with:
+          python-version: "3.12"
+
+      - name: Build Documentation
+        run: |
+          uv run invoke docs.build
+          touch .html-documentation/.nojekyll
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4.8.0
+        with:
+          branch: gh-pages
+          folder: .html-documentation
+          git-config-name: Github Action
+          git-config-email: nico.coretti@gmail.com

crc_rust-0.1.0/.github/workflows/pr-merge.yml

@@ -0,0 +1,39 @@
+name: PR-Merge
+
+on:
+  push:
+    branches:
+      - 'master'
+
+jobs:
+
+  ci-job:
+    name: Checks
+    uses: ./.github/workflows/checks.yml
+
+  publish-coverage:
+      name: Publish Code Coverage
+      runs-on: ubuntu-latest
+      steps:
+        - name: SCM Checkout
+          uses: actions/checkout@v6
+
+        - name: Setup Python Environment
+          uses: ./.github/actions/python-environment
+          with:
+            python-version: 3.12
+
+        - name: Collect Code Coverage
+          run: uv run invoke test.coverage
+          env:
+            COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+
+        - name: Publish Code Coverage
+          env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          run: uv run coveralls --service=github
+
+
+  publish-docs:
+    name: Publish Documentation
+    uses: ./.github/workflows/gh-pages.yml

crc_rust-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+worktree-*
+.bundles/
+.grade-venv/
+orig_src/
+__pycache__/
+target/
+*.so
+build/
+rust/*/target/

crc_rust-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+default_stages: [ push ]
+repos:
+  - repo: local
+    hooks:
+      - id: fmt
+        name: fmt
+        entry: echo "foo"
+        language: system
+        always_run: true
+        types: [ python ]