templatepy 0.2.8.dev0__tar.gz → 0.3.2__tar.gz

templatepy-0.3.2/CITATION.cff

@@ -0,0 +1,17 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+type: software
+title: "templatepy: Copier template for modern Python packages"
+repository-code: https://github.com/larsrollik/templatepy
+url: https://larsrollik.github.io/templatepy
+license: BSD-3-Clause
+authors:
+  - family-names: Rollik
+    given-names: Lars B.
+    orcid: https://orcid.org/0000-0003-0160-6971
+
+# After first Zenodo release, add:
+# identifiers:
+#   - type: doi
+#     value: 10.5281/zenodo.XXXXXXX
+#     description: Zenodo concept DOI

templatepy-0.3.2/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: templatepy
+Version: 0.3.2
+Summary: Copier template for modern Python packages
+Project-URL: Homepage, https://github.com/larsrollik/templatepy
+Project-URL: Documentation, https://larsrollik.github.io/templatepy
+Project-URL: Repository, https://github.com/larsrollik/templatepy
+Author-email: "Lars B. Rollik" <l.b.rollik@protonmail.com>
+Keywords: copier,packaging,python,template
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# templatepy
+
+Copier template for modern Python packages.
+
+**[→ Full documentation](https://larsrollik.github.io/templatepy)**
+
+## Stack
+
+| Tool | Role |
+|---|---|
+| uv | dependency management, virtual environments |
+| hatchling + hatch-vcs | build backend; version from git tags |
+| commitizen | Conventional Commits enforcement; auto bump on merge |
+| ruff | linting + formatting |
+| mypy | static type checking |
+| pytest + pytest-cov | testing with coverage |
+| gitleaks | secret scanning |
+
+## Quickstart
+
+```sh
+uv tool install copier
+copier copy gh:larsrollik/templatepy my-new-project
+cd my-new-project
+git init && git add -A && git commit -m "chore: initial commit from templatepy"
+uv sync --extra dev
+uv run pre-commit install --hook-type pre-commit --hook-type commit-msg
+```
+
+## Update existing project
+
+```sh
+cd my-existing-project && copier update
+```
+
+## Release flow
+
+```
+feature branch  →  PR  →  CI gate (lint + test + secrets) must pass
+                           merge blocked until green
+                               ↓
+                           merge to main (rebase)
+                               ↓
+                           bump.yml fires: cz bump → tag vX.Y.Z
+                               ↓
+                           release.yml fires on tag:
+                           → GitHub release (wheel + sdist attached)
+                           → PyPI via OIDC trusted publishing (no stored token)
+                           → Zenodo webhook (if enabled)
+```
+
+## PyPI setup (one-time per repo)
+
+Uses OIDC trusted publishing — no API token stored in GitHub secrets.
+
+1. pypi.org → project → Settings → Publishing → Add trusted publisher
+2. Owner: `<github-user>`, Repository: `<repo>`, Workflow: `release.yml`
+3. Done — the workflow handles authentication automatically.
+
+## Branch protection (required for CI gate)
+
+Repo settings → Branches → Add rule for `main`:
+- ✅ Require status checks: `CI` job
+- ✅ Require branches to be up to date
+- ✅ Require linear history
+
+For the auto-bump workflow to push the bump commit back to main:
+- ✅ Allow specified actors to bypass → add `github-actions[bot]`
+
+## Docs
+
+```sh
+uv run mkdocs serve
+```
+
+Deploy to GitHub Pages on push to main via `docs.yml` (automatic).

templatepy-0.3.2/README.md

@@ -0,0 +1,76 @@
+# templatepy
+
+Copier template for modern Python packages.
+
+**[→ Full documentation](https://larsrollik.github.io/templatepy)**
+
+## Stack
+
+| Tool | Role |
+|---|---|
+| uv | dependency management, virtual environments |
+| hatchling + hatch-vcs | build backend; version from git tags |
+| commitizen | Conventional Commits enforcement; auto bump on merge |
+| ruff | linting + formatting |
+| mypy | static type checking |
+| pytest + pytest-cov | testing with coverage |
+| gitleaks | secret scanning |
+
+## Quickstart
+
+```sh
+uv tool install copier
+copier copy gh:larsrollik/templatepy my-new-project
+cd my-new-project
+git init && git add -A && git commit -m "chore: initial commit from templatepy"
+uv sync --extra dev
+uv run pre-commit install --hook-type pre-commit --hook-type commit-msg
+```
+
+## Update existing project
+
+```sh
+cd my-existing-project && copier update
+```
+
+## Release flow
+
+```
+feature branch  →  PR  →  CI gate (lint + test + secrets) must pass
+                           merge blocked until green
+                               ↓
+                           merge to main (rebase)
+                               ↓
+                           bump.yml fires: cz bump → tag vX.Y.Z
+                               ↓
+                           release.yml fires on tag:
+                           → GitHub release (wheel + sdist attached)
+                           → PyPI via OIDC trusted publishing (no stored token)
+                           → Zenodo webhook (if enabled)
+```
+
+## PyPI setup (one-time per repo)
+
+Uses OIDC trusted publishing — no API token stored in GitHub secrets.
+
+1. pypi.org → project → Settings → Publishing → Add trusted publisher
+2. Owner: `<github-user>`, Repository: `<repo>`, Workflow: `release.yml`
+3. Done — the workflow handles authentication automatically.
+
+## Branch protection (required for CI gate)
+
+Repo settings → Branches → Add rule for `main`:
+- ✅ Require status checks: `CI` job
+- ✅ Require branches to be up to date
+- ✅ Require linear history
+
+For the auto-bump workflow to push the bump commit back to main:
+- ✅ Allow specified actors to bypass → add `github-actions[bot]`
+
+## Docs
+
+```sh
+uv run mkdocs serve
+```
+
+Deploy to GitHub Pages on push to main via `docs.yml` (automatic).

templatepy-0.3.2/VERSION

@@ -0,0 +1 @@
+0.3.2

templatepy-0.3.2/copier.yaml

@@ -0,0 +1,64 @@
+# templatepy — copier template configuration
+# Usage: copier copy gh:larsrollik/templatepy my-new-project
+# Update: copier update (inside an existing generated project)
+
+_subdirectory: template
+_min_copier_version: "9.0"
+_answers_file: .copier-answers.yml
+
+# Use [[ ]] delimiters in template files to avoid conflicts with
+# GitHub Actions ${{ }} expression syntax.
+_envops:
+  block_start_string: "[%"
+  block_end_string: "%]"
+  variable_start_string: "[["
+  variable_end_string: "]]"
+  comment_start_string: "[#"
+  comment_end_string: "#]"
+
+# ---------------------------------------------------------------------------
+# Questions
+# ---------------------------------------------------------------------------
+
+project_name:
+  type: str
+  help: "Human-readable project name (e.g. 'My Awesome Project')"
+
+project_slug:
+  type: str
+  help: "Python package name — lowercase, underscores (e.g. 'my_awesome_project')"
+  default: "{{ project_name | lower | replace(' ', '_') | replace('-', '_') }}"
+
+project_description:
+  type: str
+  help: "Short one-line description"
+
+author_name:
+  type: str
+  help: "Your full name"
+
+author_email:
+  type: str
+  help: "Your email address"
+
+github_username:
+  type: str
+  help: "GitHub username or organization"
+
+github_repo:
+  type: str
+  help: "GitHub repository name"
+  default: "{{ project_slug | replace('_', '-') }}"
+
+python_requires:
+  type: str
+  help: "Minimum Python version"
+  default: "3.12"
+  choices:
+    - "3.12"
+    - "3.13"
+
+year:
+  type: int
+  help: "Copyright year"
+  default: "{{ '%Y' | strftime }}"

templatepy-0.3.2/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "templatepy"
+dynamic = ["version"]
+description = "Copier template for modern Python packages"
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [
+    {name = "Lars B. Rollik", email = "l.b.rollik@protonmail.com"},
+]
+keywords = ["copier", "template", "packaging", "python"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Code Generators",
+]
+
+[project.urls]
+Homepage = "https://github.com/larsrollik/templatepy"
+Documentation = "https://larsrollik.github.io/templatepy"
+Repository = "https://github.com/larsrollik/templatepy"
+
+[tool.hatch.version]
+source = "vcs"
+fallback-version = "0.3.0"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/templatepy"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"copier.yaml" = "templatepy/copier.yaml"
+"template" = "templatepy/template"
+
+[tool.hatch.build.targets.sdist]
+include = ["src", "copier.yaml", "template", "CITATION.cff", "README.md", "VERSION"]
+
+[tool.commitizen]
+version_provider = "commitizen"
+version = "0.3.2"
+version_files = ["VERSION"]
+tag_format = "v$version"
+update_changelog_on_bump = false

templatepy-0.3.2/src/templatepy/__init__.py

@@ -0,0 +1,6 @@
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("templatepy")
+except PackageNotFoundError:
+    __version__ = "unknown"

templatepy-0.3.2/template/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Something isn't working
+labels: bug
+---
+
+## Description
+
+_Clear description of the bug._
+
+## Steps to reproduce
+
+1. ...
+2. ...
+
+## Expected behaviour
+
+_What should happen._
+
+## Actual behaviour
+
+_What actually happens._
+
+## Environment
+
+- OS:
+- Python version:
+- Package version:
+
+## Additional context
+
+_Logs, screenshots, related issues._

templatepy-0.3.2/template/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea or improvement
+labels: enhancement
+---
+
+## Problem
+
+_What problem does this solve? What use case does it enable?_
+
+## Proposed solution
+
+_Describe what you'd like to see._
+
+## Alternatives considered
+
+_Other approaches you've thought about._
+
+## Additional context
+
+_Anything else relevant._

templatepy-0.3.2/template/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+## Summary
+
+_What does this PR do? Link to any relevant issue with `closes #N`._
+
+## Type
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Refactor / cleanup
+- [ ] Docs / chore
+
+## Checklist
+
+- [ ] Branch created from `main`
+- [ ] Commits follow Conventional Commits (`cz commit`)
+- [ ] Version bumped with `cz bump` and pushed with `--follow-tags` (if releasing)
+- [ ] Tests added or updated
+- [ ] `uv run pre-commit run --all-files` passes locally

templatepy-0.3.2/template/.github/workflows/bump.yml

@@ -0,0 +1,47 @@
+name: Auto bump
+
+# Runs after every push to main. If there are bumpable conventional commits
+# since the last tag, creates a version bump commit + tag and pushes both.
+# The tag push then triggers release.yml.
+#
+# Loop prevention: skips if the triggering commit message starts with "bump:"
+# (i.e. the bump commit itself just pushed back to main).
+#
+# Branch protection: the github-actions bot must be allowed to push to main.
+# Repo settings → Branches → edit main rule →
+#   "Allow specified actors to bypass required pull requests" → add github-actions[bot]
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+
+jobs:
+  bump:
+    name: Version bump
+    runs-on: ubuntu-latest
+    if: "!startsWith(github.event.head_commit.message, 'bump:')"
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Configure git identity
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - uses: astral-sh/setup-uv@v5
+
+      - name: Bump version
+        run: |
+          uvx commitizen bump --yes || EXIT=$?
+          if [ "${EXIT:-0}" -eq 21 ]; then
+            echo "No bumpable commits since last tag — skipping release."
+            exit 0
+          fi
+          [ "${EXIT:-0}" -eq 0 ] || exit $EXIT
+          git push --follow-tags

templatepy-0.3.2/template/.github/workflows/ci.yml

@@ -0,0 +1,83 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+    tags-ignore: ["v*"]   # tag pushes are handled by release.yml
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0   # needed for hatch-vcs version derivation
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "[[ python_requires ]]"
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run pre-commit (ruff + mypy + commitizen + gitleaks)
+        run: uv run pre-commit run --all-files --show-diff-on-failure
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run tests
+        run: uv run pytest
+
+  secrets-scan:
+    name: Secrets scan
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: gitleaks/gitleaks-action@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    needs: [lint, test, secrets-scan]
+    if: always()
+    steps:
+      - name: Check required jobs
+        run: |
+          if [[ "${{ needs.lint.result }}" != "success" ]]; then
+            echo "lint failed" && exit 1
+          fi
+          if [[ "${{ needs.test.result }}" != "success" && "${{ needs.test.result }}" != "skipped" ]]; then
+            echo "test failed" && exit 1
+          fi
+          if [[ "${{ needs.secrets-scan.result }}" != "success" ]]; then
+            echo "secrets-scan failed" && exit 1
+          fi
+          echo "All required checks passed."

templatepy-0.3.2/template/.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "src/**/*.py"   # rebuild on source changes if using mkdocstrings
+
+permissions:
+  contents: write   # needed for gh-deploy to push to gh-pages branch
+
+jobs:
+  deploy:
+    name: Deploy docs to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0   # full history for git-revision-date plugin (if added later)
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "[[ python_requires ]]"
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Deploy
+        run: uv run mkdocs gh-deploy --force

templatepy-0.3.2/template/.github/workflows/pr-review.yml

@@ -0,0 +1,96 @@
+name: PR Review (optional LLM)
+
+# Optional AI-assisted pull request review.
+# Uncomment ONE of the sections below and configure the required secret.
+#
+# This workflow has a no-op placeholder job so it stays valid while
+# both options remain commented out.
+
+on:
+  pull_request:
+    types: [opened, synchronize, ready_for_review]
+
+jobs:
+
+  # ── Option A: Claude API (Anthropic) ─────────────────────────────────────
+  # Requires secret: ANTHROPIC_API_KEY
+  # Docs: https://docs.anthropic.com/en/api/getting-started
+  #
+  # llm-review-claude:
+  #   name: Claude PR review
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #       with:
+  #         fetch-depth: 0
+  #
+  #     - name: Generate diff
+  #       id: diff
+  #       run: |
+  #         DIFF=$(git diff origin/main...HEAD -- '*.py' | head -c 8000)
+  #         echo "content<<EOF" >> "$GITHUB_OUTPUT"
+  #         echo "$DIFF"        >> "$GITHUB_OUTPUT"
+  #         echo "EOF"          >> "$GITHUB_OUTPUT"
+  #
+  #     - name: Review with Claude
+  #       env:
+  #         ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
+  #         GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #         PR_NUMBER: ${{ github.event.pull_request.number }}
+  #       run: |
+  #         if [ -z "$ANTHROPIC_API_KEY" ]; then
+  #           echo "ANTHROPIC_API_KEY not set — skipping."
+  #           exit 0
+  #         fi
+  #         REVIEW=$(curl -s https://api.anthropic.com/v1/messages \
+  #           -H "x-api-key: $ANTHROPIC_API_KEY" \
+  #           -H "anthropic-version: 2023-06-01" \
+  #           -H "content-type: application/json" \
+  #           -d "{
+  #             \"model\": \"claude-sonnet-4-6\",
+  #             \"max_tokens\": 1024,
+  #             \"messages\": [{
+  #               \"role\": \"user\",
+  #               \"content\": \"Review this Python PR diff for bugs, style issues, and improvements. Be concise.\n\n${{ steps.diff.outputs.content }}\"
+  #             }]
+  #           }" | python3 -c "import sys,json; print(json.load(sys.stdin)['content'][0]['text'])")
+  #         gh pr comment "$PR_NUMBER" --body "## Claude PR Review\n\n${REVIEW}"
+
+  # ── Option B: Local Ollama (self-hosted runner) ───────────────────────────
+  # Requires: a self-hosted runner with Ollama running on localhost:11434
+  # Docs: https://ollama.com / https://docs.github.com/en/actions/hosting-your-own-runners
+  #
+  # llm-review-ollama:
+  #   name: Ollama PR review
+  #   runs-on: self-hosted
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #       with:
+  #         fetch-depth: 0
+  #
+  #     - name: Generate diff
+  #       id: diff
+  #       run: |
+  #         DIFF=$(git diff origin/main...HEAD -- '*.py' | head -c 4000)
+  #         echo "content<<EOF" >> "$GITHUB_OUTPUT"
+  #         echo "$DIFF"        >> "$GITHUB_OUTPUT"
+  #         echo "EOF"          >> "$GITHUB_OUTPUT"
+  #
+  #     - name: Review with Ollama
+  #       env:
+  #         GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #         PR_NUMBER: ${{ github.event.pull_request.number }}
+  #         OLLAMA_MODEL: "llama3.2"   # change to your preferred model
+  #       run: |
+  #         PROMPT="Review this Python PR diff for bugs, style issues, and improvements. Be concise.\n\n${{ steps.diff.outputs.content }}"
+  #         REVIEW=$(curl -s http://localhost:11434/api/generate \
+  #           -d "{\"model\": \"${OLLAMA_MODEL}\", \"prompt\": \"${PROMPT}\", \"stream\": false}" \
+  #           | python3 -c "import sys,json; print(json.load(sys.stdin)['response'])")
+  #         gh pr comment "$PR_NUMBER" --body "## Ollama PR Review (${OLLAMA_MODEL})\n\n${REVIEW}"
+
+  # Placeholder — remove once an option above is uncommented
+  no-op:
+    name: LLM review (not configured)
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "LLM PR review not configured. See .github/workflows/pr-review.yml."

templatepy-0.3.2/template/.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v[0-9]*"
+
+permissions:
+  contents: write
+  id-token: write  # required for PyPI OIDC trusted publishing
+
+jobs:
+  release:
+    name: Build, release, publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # required for hatch-vcs to read tags
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "[[ python_requires ]]"
+
+      - name: Build
+        run: uv build
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: false
+
+      - name: Publish to PyPI
+        run: uv publish --trusted-publishing automatic