chore: manually run cruft update

Author: 56kyle

.cookiecutter.json

@@ -1,5 +1,5 @@
 {
-  "_commit": "4935237cbea7516d432242e7383dd659be526538",
+  "_commit": "269b42a8d0e92911e296973e6a68b80ee6932207",
   "_template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python",
   "add_rust_extension": false,
   "author": "Kyle Oliver",

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python",
-  "commit": "4935237cbea7516d432242e7383dd659be526538",
+  "commit": "269b42a8d0e92911e296973e6a68b80ee6932207",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -18,7 +18,7 @@
       "license": "MIT",
       "development_status": "Development Status :: 1 - Planning",
       "_template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python",
-      "_commit": "4935237cbea7516d432242e7383dd659be526538"
+      "_commit": "269b42a8d0e92911e296973e6a68b80ee6932207"
     }
   },
   "directory": null

.github/workflows/release-python.yml

@@ -6,23 +6,18 @@ name: Release Python Package
 on:
   push:
     tags:
-      # Trigger on SemVer tags. Commitizen configured in pyproject.toml (Area 12)
-      # uses PEP 440 which is SemVer compatible.
       - "v[0-9]+.[0-9]+.[0-9]+"
       - "v[0-9]+.[0-9]+.[0-9]+-*" # Include pre-release tags
 
-  # Allow workflow to be run manually from the Actions tab for a specific tag
   workflow_dispatch:
     inputs:
       tag:
-        description: 'Git tag to build and release (e.g., v1.2.3). Must already exist.'
-        required: true # User must provide a tag when manually dispatching
+        description: "Git tag to build and release (e.g., v1.2.3). Must already exist."
+        required: true
 
 jobs:
-  # Job 1: Build the package and publish to TestPyPI
   build_and_testpypi:
     name: Build & Publish to TestPyPI
-    # Run on a consistent, standard build environment
     runs-on: ubuntu-latest
 
     steps:
@@ -40,42 +35,31 @@ jobs:
           python-version-file: .python-version
 
       - name: Upload built package artifacts
-        # Upload packages so the publish job can access them.
         uses: actions/upload-artifact@v4
         with:
-          name: distribution-packages # Name the artifact
-          path: dist/ # Path to the built sdist/wheel files
-          retention-days: 7 # Keep built artifacts for 7 days
+          name: distribution-packages
+          path: dist/
+          retention-days: 7
 
       - name: Download built package artifacts
         uses: actions/download-artifact@v4
         with:
-          name: distribution-packages-{{ github.event.inputs.tag }}
+          name: distribution-packages-${{ github.event.inputs.tag }}
           path: dist/
 
-      # --- Publish to TestPyPI Step ---
-      # This step runs within the same job after build.
       - name: Publish to TestPyPI
-        # Execute the Task Automation publish session for TestPyPI.
-        # This calls uv publish dist/* with TestPyPI credentials/config (Topic 10).
         env:
-          # TestPyPI credentials stored as secrets in GitHub Settings -> Secrets
-          TWINE_USERNAME: __token__ # Standard username when using API tokens
-          TWINE_PASSWORD: ${{ secrets.TESTPYPI_API_TOKEN }} # Use GitHub Encrypted Secret
-          # Optional: If uv publish requires different config for repository URL, pass TWINE_REPOSITORY or similar
-        run: uvx nox -s publish-package -- --repository testpypi # Call the publish-package session, passing repository arg
-
-      # --- Get Changelog Content for Release Notes ---
-      # Use a standard action to extract changelog content.
-      # This action requires a standard CHANGELOG.md format.
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TESTPYPI_API_TOKEN }}
+        run: uvx nox -s publish-package -- --repository testpypi
+
       - name: Get Release Notes from Changelog
         id: changelog
-        uses: simple-changelog/action@v3 # Action to parse CHANGELOG.md
+        uses: simple-changelog/action@v3
         with:
-          path: CHANGELOG.md # Path to your CHANGELOG.md
-          tag: ${{ github.event_name == 'push' && github.ref_name || github.event.inputs.tag }} # Pass the tag name
+          path: CHANGELOG.md
+          tag: ${{ github.event_name == 'push' && github.ref_name || github.event.inputs.tag }}
 
-      # Define outputs from this job that other jobs (like create_github_release) can use.
     outputs:
       changelog_body:
         description: "Release notes body extracted from CHANGELOG.md"
@@ -119,7 +103,6 @@ jobs:
           # Optional: TWINE_REPOSITORY if publishing to a custom production index
         run: uvx nox -s publish-package # Call the publish-package session (defaults to pypi.org)
 
-
   # Job 3: Create GitHub Release (Runs regardless of PyPI publish success, relies on build job for info/artifacts)
   create_github_release:
     name: Create GitHub Release
@@ -151,7 +134,6 @@ jobs:
           # The body of the release notes - access the output from the 'build_and_testpypi' job
           body: ${{ needs.build_and_testpypi.outputs.changelog_body }} # Access changelog body from dependent job output
 
-
           files: dist/* # Attach built sdist and wheel files as release assets
           # Optional: Mark as a draft release for manual review before publishing
           # draft: true

.github/workflows/security-python.yml

@@ -18,13 +18,13 @@ on:
       - main
       - master
     paths:
-      - 'src/**/*.py'
-      - 'tests/**/*.py'
-      - 'noxfile.py'
-      - 'pyproject.toml'
-      - '.bandit'
-      - '.ruff.toml'
-      - '.github/workflows/security-python.yml'
+      - "src/**/*.py"
+      - "tests/**/*.py"
+      - "noxfile.py"
+      - "pyproject.toml"
+      - ".bandit"
+      - ".ruff.toml"
+      - ".github/workflows/security-python.yml"
 
   workflow_dispatch:
 

.pre-commit-config.yaml

@@ -60,6 +60,12 @@ repos:
       - id: prettier
         name: Prettier
 
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.33.1
+    hooks:
+      - id: check-github-workflows
+        args: ["--verbose"]
+
   - repo: https://github.com/commitizen-tools/commitizen
     rev: v4.8.2
     hooks:

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[56kyleoliver@gmail.com](mailto:56kyleoliver@gmail.com).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing to cookiecutter-robust-python
+
+Thank you for considering contributing to the `cookiecutter-robust-python` template! We welcome contributions that help improve the template, keep its tooling current, and enhance its documentation.
+
+By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## How to Contribute
+
+There are several ways to contribute:
+
+1.  **Reporting Bugs:** If you find an issue with the template itself (e.g., it doesn't generate correctly, the generated project's workflow doesn't work on a specific OS, a tool is misconfigured), please open an issue on the [issue tracker](https://github.com/56kyle/cookiecutter-robust-python/issues). Provide clear steps to reproduce the bug.
+2.  **Suggesting Enhancements:** Have an idea for a new feature, a different tool choice you think is better, or an improvement to the template structure or documentation? Open an issue on the [issue tracker](https://github.com/56kyle/cookiecutter-robust-python/issues) to discuss your suggestion. Clearly articulate the proposed change and the rationale behind it, ideally referencing the template's philosophy and criteria ([Template Philosophy](https://56kyle.github.io/cookiecutter-robust-python/philosophy.html), [Criteria for Tool Selection](https://56kyle.github.io/cookiecutter-robust-python/criteria.html)).
+3.  **Submitting Code Contributions:** Ready to contribute code (e.g., fix a bug, implement a suggested enhancement, update a tool version)? Please fork the repository and submit a Pull Request.
+
+## Setting Up Your Development Environment
+
+Refer to the **[Getting Started: Contributing to the Template](https://56kyle.github.io/cookiecutter-robust-python/getting-started-template-contributing.html)** section in the template documentation for instructions on cloning the repository, installing template development dependencies (using uv), setting up the template's pre-commit hooks, and running template checks/tests.
+
+## Contribution Workflow
+
+1.  **Fork** the repository and **clone** your fork.
+2.  Create a **new branch** for your contribution based on the main branch. Use a descriptive name (e.g., `fix/ci-workflow-on-windows`, `feat/update-uv-version`).
+3.  Set up your development environment following the [Getting Started](https://56kyle.github.io/cookiecutter-robust-python/getting-started-template-contributing.html) guide (clone, `uv sync`, `uvx nox -s pre-commit -- install`).
+4.  Make your **code or documentation changes**.
+5.  Ensure your changes adhere to the template's **code quality standards** (configured in the template's `.pre-commit-config.yaml`, `.ruff.toml`, etc.). The pre-commit hooks will help with this. Run `uvx nox -s lint`, `uvx nox -s check` in the template repository for more comprehensive checks.
+6.  Ensure your changes **do not break existing functionality**. Run the template's test suite: `uvx nox -s test`. Ideally, add tests for new functionality or bug fixes.
+7.  Ensure the **template documentation builds correctly** with your changes: `uvx nox -s docs`.
+8.  Write clear, concise **commit messages** following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification where possible, especially for significant changes (fixes, features, chore updates, etc.).
+9.  **Push** your branch to your fork.
+10. **Open a Pull Request** from your branch to the main branch of the main template repository. Provide a clear description of your changes. Link to any relevant issues.
+
+## Updating Tool Evaluations
+
+If your contribution involves updating a major tool version or suggesting a different tool entirely, you **must** update the relevant sections in the template's documentation (`docs/topics/` files) to reflect the changes in configuration, behavior, or re-justify the choice based on the current state of the tools and criteria. This is crucial for keeping the documentation accurate and useful over time.
+
+## Communication
+
+For questions or discussion about contributions, open an issue or a discussion on the [GitHub repository](https://github.com/56kyle/cookiecutter-robust-python).
+
+---

noxfile.py

@@ -132,7 +132,7 @@ def tests_python(session: Session) -> None:
 def docs_build(session: Session) -> None:
     """Build the project documentation (Sphinx)."""
     session.log("Installing documentation dependencies...")
-    session.install("-e", ".", "--group", "dev")
+    session.install("-e", ".", "--group", "docs")
 
     session.log(f"Building documentation with py{session.python}.")
     docs_build_dir = Path("docs") / "_build" / "html"

pyproject.toml

@@ -28,20 +28,21 @@ dev = [
     "nox>=2025.5.1",
     "pre-commit>=4.2.0",
     "pre-commit-hooks>=5.0.0",
+    "ruff>=0.11.9",
+    "bandit>=1.8.3",
+    "pip-audit>=2.9.0",
+    "pytest>=8.3.5",
+    "pytest-cov>=6.1.1",
+    "pyright>=1.1.400",
+]
+docs = [
     "furo>=2024.8.6",
     "myst-parser>=3.0.1",
     "sphinx>=7.4.7",
     "sphinx-autodoc-typehints>=2.3.0",
     "sphinx-copybutton>=0.5.2",
     "sphinx-tabs>=3.4.7",
     "sphinxcontrib-typer>=0.5.1",
-    "pydocstyle>=6.3.0",
-    "ruff>=0.11.9",
-    "bandit>=1.8.3",
-    "pip-audit>=2.9.0",
-    "pytest>=8.3.5",
-    "pytest-cov>=6.1.1",
-    "pyright>=1.1.400",
 ]
 
 [project.urls]