Merge pull request #3 from 56kyle/develop

Develop

Author: 56kyle

cookiecutter.json

@@ -3,9 +3,9 @@
   "package_name": "{{ cookiecutter.project_name.replace('-', '_') }}",
   "friendly_name": "{{ cookiecutter.project_name.replace('-', ' ').title() }}",
   "min_python_version": "3.9",
-  "max_python_version": "3.12",
+  "max_python_version": "3.13",
   "author": "Kyle Oliver",
-  "email": "56kyleoliver@gmail.com",
+  "email": "56kyleoliver+cookiecutter-robust-python@gmail.com",
   "github_user": "56kyle",
   "version": "0.0.0",
   "copyright_year": "{% now 'utc', '%Y' %}",

noxfile.py

@@ -113,7 +113,7 @@ def test(session: Session) -> None:
         "author_name='Test Author'",
         "author_email='test@example.com'",
         "license='MIT'",
-        "python_version='3.12'", # Use a fixed version for test stability
+        "python_version='3.13'", # Use a fixed version for test stability
         "add_rust_extension='n'", # Test without Rust initially, add another test session for Rust
         # Add other variables needed by cookiecutter.json here to ensure no prompts
     ])
@@ -176,7 +176,3 @@ def release_template(session: Session):
     session.log("Template version bumped and tag created locally via Commitizen/uvx.")
     session.log("IMPORTANT: Push commits and tags to remote (`git push --follow-tags`) to trigger CD for the TEMPLATE.")
 
-
-# Default sessions to run if no arguments are given to Nox in the template repo.
-# Often includes core checks and potentially documentation build and/or template tests.
-nox.options.sessions = ["check", "docs"]

{{cookiecutter.project_name}}/.cz.toml

@@ -1,48 +1,19 @@
-# .cz.toml
-# See https://commitizen-tools.github.io/commitizen/config/
-
-# Commitizen configuration for project release management (using Conventional Commits).
-
 [tool.commitizen]
-# Format for Git tags created by cz bump. '$version' is replaced by the new version.
 tag_format = "v$version"
-
-# Versioning scheme to use for deciding the next version based on commit types.
-# See https://commitizen-tools.github.io/commitizen/versioning/ for options.
-# 'pep440' (default) is common for Python (e.g., 0.1.0, 1.2.3)
-# 'semver' is another popular standard (major.minor.patch)
 version_scheme = "pep440"
 
 # Set to true to allow bumping to 0.y.z from 0.(y-1).z when commit types normally trigger major bump.
 # Recommended for initial development phases before 1.0.0.
 major_version_zero = true
 
-# Files where the version string should be updated when 'cz bump' is run.
-# Ensure these paths and variable names match your project.
 write_version_files = [
-    # Updates the [project].version in pyproject.toml (PEP 621)
     "pyproject.toml:version",
-    # Example: Update __version__ in your package's __init__.py
     "src/{{ cookiecutter.package_name }}/__init__.py:__version__",
-    # Add other files if needed (e.g., YOUR_APP/__init__.py for complex structures)
 ]
-
-# File where Commitizen reads/writes the commit message for manual commits (standard).
 commit_msg_file = ".git/COMMIT_EDITMSG"
 
-# Optional: Define specific commit types and their impact on version bumping/changelog sections.
-# See https://commitizen-tools.github.io/commitizen/getting_started/#setting-the-cz-config
-# The default types are usually sufficient (feat, fix, breaking changes, etc.) but can be customized.
-# [tool.commitizen.commit_types]
-# feat = { description = "A new feature", section = "Features" }
-# fix = { description = "A bug fix", section = "Bug Fixes" }
-# chore = { description = "Build process or auxiliary tool changes", hidden = true }
-
-
-# Optional: Configuration for Git host integrations (e.g., creating GitHub releases).
-# See https://commitizen-tools.github.io/commitizen/changelog/#git-host-configuration
 [tool.commitizen.github]
-release = true # Enable GitHub release creation
-release_asset_path = "dist/*" # Attach build artifacts from the 'dist' directory
+release = true
+release_asset_path = "dist/*"
 release_asset_descriptions = { "*.tar.gz": "Source distribution", "*.whl": "Python Wheel" }
-base_url = "https://github.com/{{ cookiecutter.github_username | lower | replace(' ', '-') }}/{{ cookiecutter.project_slug.replace('_', '-') }}" # Your repo URL
+base_url = "https://github.com/{{ cookiecutter.github_username | lower | replace(' ', '-') }}/{{ cookiecutter.project_slug.replace('_', '-') }}"

{{cookiecutter.project_name}}/.pre-commit-config.yaml

@@ -1,68 +1,23 @@
 # .pre-commit-config.yaml
 # See https://pre-commit.com/
+default_stages: [commit]
 
-# This file configures the pre-commit framework, listing hooks that run on staged files before commits.
-# Ruff is configured to run the full set of enabled linting rules and formatting on files in the commit.
-
-# --- Default settings for hooks if not overridden ---
-default_stages: [commit] # Run hooks by default on 'commit' stage
-
-# Exclude patterns for hooks (relative to project root).
-# Ensure consistency with .gitignore. Hooks often have built-in excludes for standard dirs.
-# exclude: ^docs/.*$ # Example exclude for documentation source files (handled by Ruff excludes often)
-
-# --- Repositories containing hooks ---
 repos:
-  # Standard pre-commit hooks provided by the framework developers.
-  # See https://github.com/pre-commit/pre-commit-hooks
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    # Use a specific tag or commit hash (pinning for reproducibility).
-    rev: v4.6.0 # Update periodically to get newer hooks/fixes.
+    rev: v4.6.0
     hooks:
-      # Prevent adding large files that should probably be in Git LFS or ignored.
       - id: check-added-large-files
-        args: ["--max-size=1000000"] # Set max file size to 1MB (adjust as needed).
-
-      # Check YAML files (e.g., CI workflows, Docker Compose) for syntax errors.
+        args: ["--max-size=1000000"]
       - id: check-yaml
-
-      # Check TOML files (e.g., pyproject.toml, .ruff.toml) for syntax errors.
       - id: check-toml
-
-      # Ensure files end with a single newline and are not excessively blank at the end.
       - id: end-of-file-fixer
-
-      # Removes unwanted trailing whitespace from lines.
       - id: trailing-whitespace
 
-  # Ruff hooks (Formatter and Linter checks) from Astral.
-  # See https://github.com/astral-sh/ruff-pre-commit
-  # Match the rev/version to the version of Ruff used in the template's pyproject.toml dependencies.
-  - repo: https://github.com/astral-sh/ruff-pre-commit # Official hooks from Astral (Ruff creator)
-    # Pin to the version of Ruff used in pyproject.toml (or a compatible version).
-    rev: v0.3.5 # **Ensure this matches/is compatible with the Ruff version in pyproject.toml**
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.5
     hooks:
-      # Run the Ruff formatter (covers code formatting and import sorting).
-      # Automatically fixes issues like line length, spacing, quotes, and sorts imports.
-      # Run this hook first so the linter doesn't report fixable style issues.
       - id: ruff-format
-        # Explicitly point to the separate ruff config file.
-        args: [--config={{ PROJECT_SLUG }}/.ruff.toml] # Path relative to project root.
+        args: [--config={{ PROJECT_SLUG }}/.ruff.toml]
 
-      # Run the Ruff linter.
-      # This hook runs the *full set of enabled linting rules* configured in .ruff.toml.
-      # Use --fix to automatically fix many lint issues.
-      # Use --exit-non-zero-on-fix to make the commit fail if any fixes were applied
-      # (prompts user to 'git add' and re-commit the corrected files).
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix, --config={{ PROJECT_SLUG }}/.ruff.toml]
-
-
-  # --- Optional Hooks ---
-  # Add hooks for other tools if they are fast enough for pre-commit and needed.
-  # Ensure any tools used here are listed as development dependencies in pyproject.toml
-  # so pre-commit can install them.
-
-# Note: More time-consuming checks (e.g., full Pyright, comprehensive Bandit/pip-audit scans)
-# are typically too slow for mandated pre-commit hooks across large projects.
-# These are run via Task Automation (Nox) and enforced in CI.

{{cookiecutter.project_name}}/pyproject.toml

@@ -1,16 +1,16 @@
 [project]
 name = "{{ cookiecutter.package_name }}"
 version = "0.1.0"
-description = "{{ cookiecutter.project_description }}"
+description = "{{ cookiecutter.package_name }}"
 authors = [
     { name = "{{ cookiecutter.author_name }}", email = "{{ cookiecutter.author_email }}" },
 ]
 license = { text = "{{ cookiecutter.license }}" }
 readme = "README.md"
-requires-python = ">={{ cookiecutter.python_version }},<4.0"
+requires-python = ">={{ cookiecutter.min_python_version}},<4.0"
 
 keywords = [
-    "{{ cookiecutter.project_slug.replace('_', '-') }}",
+    "{{ cookiecutter.project_name.replace('_', '-') }}",
 ]
 
 classifiers = [
@@ -72,10 +72,6 @@ requires = [
 build-backend = {% if cookiecutter.add_rust_extension == 'y' -%} "maturin" {% else -%} "setuptools.build_meta" {% endif %}
 
 
-# --- Tool-specific configurations ---
-# Configuration details are often in separate files (.ruff.toml, pyrightconfig.json)
-# Link to their documentation for full config options.
-
 [tool.uv]
 # See https://docs.astral.sh/uv/reference/configuration/
 

{{cookiecutter.project_name}}/pyrightconfig.json

@@ -1,7 +1,3 @@
-// pyrightconfig.json
-// See https://github.com/microsoft/pyright/blob/main/docs/configuration.md
-// This file configures the Pyright static type checker.
-
 {
   "include": [
     "src",
@@ -21,74 +17,27 @@
     ".coverage",
     "rust"
   ],
-  // Path to search for virtual environments relative to this config file.
-  // "." searches in the current directory and subdirectories (like .venv).
   "venvPath": ".",
-  // Name of the default virtual environment directory to search within venvPath.
-  // UV's default is ".venv" relative to the project root.
   "venv": ".venv",
-  // Execution environments help map source paths to target Python versions/extra paths.
   "executionEnvironments": [
     {
-      // Analyze source code within the 'src' directory
       "root": "src",
-      "pythonVersion": "{{ cookiecutter.python_version }}",
-      // Paths to add to sys.path for analysis within this environment
       "extraPaths": []
     },
     {
       "root": "tests",
-      "pythonVersion": "{{ cookiecutter.python_version }}",
       "extraPaths": []
     }
   ],
-  // === Reporting Severity Levels ===
-  // Control severity for different types of issues (error, warning, information, ignore)
-  // Change these to "error" once you have addressed issues in your project for stricter enforcement.
-
-  // Reporting level for basic type issues.
   "reportMissingImports": true,
-  // Flag imports Pyright cannot find
   "reportMissingTypeStubs": true,
-  // Flag imported libraries without type stubs
 
   "reportGeneralTypeIssues": "warning",
-  // Warn about common type problems
   "reportPropertyTypeMismatch": "warning",
-  // Warn if getter/setter types don't align
   "reportReturnTypeFromAnnotation": "warning",
-  // Check consistency between return annotation and actual code path returns
-
-  // === Strictness Flags ===
-  // Enabling "strict": true turns on a comprehensive set of strict type checking rules.
-  // It's recommended to enable this once your project is well-typed for maximum safety.
-  // It's equivalent to enabling all "report..." rules listed below.
-  // "strict": true, # Uncomment and set to true for strict mode
-
-  // Alternatively, enable individual strict rules progressively:
-  // "basic": true # Enables a moderate set of strict rules (often a good starting point before full strict)
-  // See Pyright docs for descriptions of all strict rules:
-  // https://github.com/microsoft/pyright/blob/main/docs/configuration.md#information-about-type-checking-rules
-
-  // Examples of strict rules included in "strict": true or "basic": true
-  // "reportAny": "warning",                 # Disallows explicit or implicit use of 'Any'
-  // "reportUndefinedVariable": "error",     # Required. Flags uses of variables before assignment.
-  // "reportUnusedImport": "warning",        # Flags unused imports (also caught by Ruff).
-  // "reportUnusedVariable": "warning",      # Flags unused variables (also caught by Ruff).
-  // "reportMissingParameterType": "warning",# Flags function parameters missing type annotations
-  // "reportMissingReturnType": "warning",   # Flags functions missing return type annotations
-  // "reportOptionalOperand": "warning",     # Flags operations on potentially None values
-
-  // --- Other Configuration ---
-  // Set the python version explicitly for analysis context
+  "reportMissingReturnType": "warning",
+  "basic": true,
+  "reportMissingParameterType": "warning",
+  "reportOptionalOperand": "warning",
   "pythonVersion": "{{ cookiecutter.python_version }}"
-
-  // Set the python platform explicitly if cross-platform analysis is needed (less common for typical projects)
-  // "pythonPlatform": "Linux", # "Linux", "Darwin" (macOS), "Windows"
-
-  // Define custom typeshed paths if needed
-  // "typeshedPath": "path/to/typeshed",
-
-  // Specify a minimum threshold of confidence for inferred types (advanced)
-  // "analyzeUnannotatedFunctions": true, # Analyze functions even if not annotated (part of basic)
 }