Merge branch 'main' of https://github.com/seedcase-project/template-python-package into refactor/do-not-use-reusable-workflows

lwjohnst86 · lwjohnst86 · commit d665413a498a · 2026-05-22T12:48:53.000+02:00
diff --git a/.config/cog.toml b/.config/cog.toml
diff --git a/.config/rumdl.toml b/.config/rumdl.toml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -67,7 +67,7 @@ jobs:
         id: check_changes
         run: |
           # Determine if a bump is possible.
-          if [[ $(cog bump --auto --dry-run) != No* ]]; then
+          if [[ $(cog --config .config/cog.toml bump --auto --dry-run) != No* ]]; then
             echo "has_changes=true" >> $GITHUB_OUTPUT
           else
             echo "has_changes=false" >> $GITHUB_OUTPUT
@@ -76,7 +76,7 @@ jobs:
       - name: Create tag and update changelog
         if: steps.check_changes.outputs.has_changes == 'true'
         run: |
-          cog bump --auto
+          cog --config .config/cog.toml bump --auto
 
       - name: Create GitHub release
         if: steps.check_changes.outputs.has_changes == 'true'
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -29,6 +29,6 @@ repos:
       - id: typos
 
   - repo: https://github.com/rvben/rumdl-pre-commit
-    rev: v0.1.94
+    rev: v0.1.96
     hooks:
       - id: rumdl-fmt # Auto-format
diff --git a/404.qmd b/404.qmd
@@ -6,6 +6,7 @@ Let's get you back to greener grounds.
 
 👉 Go to [homepage](/index.qmd).
 
-![](/_extensions/seedcase-project/seedcase-theme/images/404.svg){fig-alt="An illustration of the number 404 surrounded by trees and mountains"}
+![](/_extensions/seedcase-project/seedcase-theme/images/404.svg){fig-alt="An
+illustration of the number 404 surrounded by trees and mountains"}
 
 ## Illustration by [Storyset](https://storyset.com/online) {.appendix}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,48 @@ within each release.
 Commits from bots, like `dependabot` or `pre-commit-ci`, are not
 included in the changelog.
 
+## [0.23.1](https://github.com/seedcase-project/template-python-package/compare/0.23.0..0.23.1) - 2026-05-22
+
+### ♻️ Refactor
+
+- Move config files into `.config/` or `pyproject.toml`
+  [#280](https://github.com/seedcase-project/template-python-package/pull/280)
+  by [`@lwjohnst86`](https://github.com/lwjohnst86)
+  ([f65c2bc](https://github.com/seedcase-project/template-python-package/commit/f65c2bc7fad7654ed5261bd9e5d0614121905e17))
+
+## [0.23.0](https://github.com/seedcase-project/template-python-package/compare/0.22.3..0.23.0) - 2026-05-22
+
+### ✨ Features
+
+- Add `pyproject.toml` classifiers for better discoverability
+  [#290](https://github.com/seedcase-project/template-python-package/pull/290)
+  by [`@lwjohnst86`](https://github.com/lwjohnst86)
+  ([fd37f23](https://github.com/seedcase-project/template-python-package/commit/fd37f23ad574d992566e6f85808f11f28e2852dc))
+
+## [0.22.3](https://github.com/seedcase-project/template-python-package/compare/0.22.2..0.22.3) - 2026-05-22
+
+### ♻️ Refactor
+
+- Remove Conventional Commit scopes and use raw emoji
+  [#283](https://github.com/seedcase-project/template-python-package/pull/283)
+  by [`@lwjohnst86`](https://github.com/lwjohnst86)
+  ([03ab0ba](https://github.com/seedcase-project/template-python-package/commit/03ab0ba6d9b8dbbf6ade4232b4458dc5fc913902))
+- Remove `build-pdf` from justfile, not needed anymore
+  [#288](https://github.com/seedcase-project/template-python-package/pull/288)
+  by [`@lwjohnst86`](https://github.com/lwjohnst86)
+  ([3ca4fe5](https://github.com/seedcase-project/template-python-package/commit/3ca4fe5277ebfe6806e5b7db7cbbe361cec63a7d))
+- Switch to using `uvx` for dev tooling, `uv run` isn't needed
+  [#285](https://github.com/seedcase-project/template-python-package/pull/285)
+  by [`@lwjohnst86`](https://github.com/lwjohnst86)
+  ([126dca2](https://github.com/seedcase-project/template-python-package/commit/126dca25c77882ad4188a330c504587e7eb7a680))
+
+### 📝 Documentation
+
+- Minor clean up of docs
+  [#286](https://github.com/seedcase-project/template-python-package/pull/286)
+  by [`@lwjohnst86`](https://github.com/lwjohnst86)
+  ([73f4bb6](https://github.com/seedcase-project/template-python-package/commit/73f4bb69f0ce9565c1bd40ba3cb38eb55e79a693))
+
 ## [0.22.2](https://github.com/seedcase-project/template-python-package/compare/0.22.1..0.22.2) - 2026-05-19
 
 ### ♻️ Refactor
diff --git a/docs/includes/site-counter.html b/docs/includes/site-counter.html
@@ -1,3 +1,2 @@
-<!-- TODO: Set up GoatCounter -->
 <script data-goatcounter="https://seedcase-template-python-package.goatcounter.com/count" async
   src="//gc.zgo.at/count.js"></script>
diff --git a/index.qmd b/index.qmd
@@ -1,5 +1,5 @@
 ---
-title: An opinionated template for Python Packages
+title: "{{< meta tagline >}}"
 ---
 
 {{< include /docs/includes/_badges.qmd >}}
diff --git a/justfile b/justfile
@@ -27,7 +27,8 @@ update-quarto-theme:
 
 # Update files in the template from the Copier parent folder
 sync-template-files:
-  cp CODE_OF_CONDUCT.md .pre-commit-config.yaml .typos.toml .editorconfig .rumdl.toml template/
+  cp CODE_OF_CONDUCT.md .pre-commit-config.yaml .typos.toml .editorconfig template/
+  cp .config/rumdl.toml template/.config/
   mkdir -p template/tools
   cp tools/get-contributors.sh template/tools/
   cp .github/pull_request_template.md template/.github/
diff --git a/template/.config/mypy.ini b/template/.config/mypy.ini
diff --git a/template/.config/quartodoc.py b/template/.config/quartodoc.py
diff --git a/template/.config/ruff.toml b/template/.config/ruff.toml
diff --git a/template/.config/rumdl.toml b/template/.config/rumdl.toml
@@ -3,12 +3,12 @@
 line_length = 72
 flavor = "quarto"
 exclude = [
-    # Common directories to exclude
-    ".github",
-    # This is auto-generated from the qmd version
-    "**/README.md",
-    # This has it's own structure
-    "**/LICENSE.md"
+  # Common directories to exclude
+  ".github",
+  # This is auto-generated from the qmd version
+  "**/README.md",
+  # This has it's own structure
+  "**/LICENSE.md",
 ]
 
 # List style: `-`
diff --git a/template/.github/dependabot.yml b/template/.github/dependabot.yml
@@ -6,12 +6,10 @@ updates:
       interval: monthly
     commit-message:
       prefix: ci
-      include: scope
 
   - package-ecosystem: uv
     directory: /
     schedule:
       interval: monthly
     commit-message:
       prefix: build
-      include: scope
diff --git a/template/.pre-commit-config.yaml b/template/.pre-commit-config.yaml
@@ -1,8 +1,8 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 ci:
-  autofix_commit_msg: "chore(pre-commit): :pencil2: automatic fixes"
-  autoupdate_commit_msg: "ci(pre-commit): :construction_worker: update pre-commit CI version"
+  autofix_commit_msg: "chore: ✏️ automatic pre-commit hook fixes"
+  autoupdate_commit_msg: "ci: 👷 update pre-commit CI version"
 
 repos:
   - repo: https://github.com/gitleaks/gitleaks
diff --git a/template/.typos.toml b/template/.typos.toml
@@ -1,10 +1,14 @@
 [files]
 extend-exclude = [
+  "*.html",
   "*.json",
   "*.css",
   ".quarto/*",
   "_site/*",
   "_extensions/*",
   ".coverage-report/*",
   "site_libs/",
+  "*.svg",
+  # Since it has hashes
+  "CHANGELOG.md",
 ]
diff --git a/template/.vscode/settings.json b/template/.vscode/settings.json
@@ -35,4 +35,8 @@
   "python.testing.pytestEnabled": true,
   "python.testing.pytestPath": "${workspaceFolder}/.venv/bin/pytest",
   "mypy.runUsingActiveInterpreter": true,
+  "ruff.configuration": ".config/ruff.toml",
+  "mypy.configFile": ".config/mypy.ini",
+  "conventionalCommits.emojiFormat": "emoji",
+  "conventionalCommits.promptScopes": false
 }
diff --git a/template/TODO.md b/template/TODO.md
@@ -4,7 +4,7 @@
   after copying the project.
 - Run `git init -b main` to create the project as a Git repository.
 - Install these packages
-  `uv add --dev pre-commit ruff typos pytest bandit commitizen genbadge jupyter pytest-cov quartodoc types-tabulate mypy vulture`
+  `uv add --dev pytest genbadge jupyter pytest-cov quartodoc quarto types-tabulate mypy`
 - Run `just list-todos` and complete all the TODO items.
 - Run `just install-precommit` to install the pre-commit hooks.
 - Run `just build-readme` to build the Markdown version of the README.
diff --git a/template/_quarto.yml.jinja b/template/_quarto.yml.jinja
@@ -67,7 +67,7 @@ quartodoc:
   parser: google
   dynamic: true
   renderer:
-    style: _renderer.py
+    style: .config/quartodoc.py
     table_style: description-list
     show_signature_annotations: true
 
diff --git a/template/justfile.jinja b/template/justfile.jinja
@@ -54,14 +54,14 @@ test-python:
 # Check Python code for any errors that need manual attention
 check-python:
   # Check formatting
-  uv run ruff check .
+  uvx ruff check . --config .config/ruff.toml
   # Check types
-  uv run mypy --pretty .
+  uv run mypy --pretty . --config-file .config/mypy.ini
 
 # Reformat Python code to match coding style and general structure
 format-python:
-  uv run ruff check --fix .
-  uv run ruff format .
+  uvx ruff check --fix . --config .config/ruff.toml
+  uvx ruff format . --config .config/ruff.toml
 
 # Format Markdown files
 format-md:
@@ -99,11 +99,11 @@ check-commits:
 
 # Run basic security checks on the package
 check-security:
-  uv run bandit -r src/
+  uvx bandit -r src/
 
 # Check for spelling errors in files
 check-spelling:
-  uv run typos
+  uvx typos
 
 # Install lychee from https://lychee.cli.rs/guides/getting-started/
 # Check that URLs work
@@ -113,16 +113,6 @@ check-urls:
     --extensions md,qmd,py \
     --exclude-path "_badges.qmd"
 
-# Build the documentation as PDF using Quarto
-build-pdf:
-  # To let Quarto know where python is.
-  export QUARTO_PYTHON=.venv/bin/python3
-  uv run quarto install tinytex
-  # For generating images from Mermaid diagrams
-  uv run quarto install chromium
-  uv run quarto render --profile pdf --to pdf
-  find docs -name "mermaid-figure-*.png" -delete
-
 # Check for unused code in the package and its tests
 check-unused:
   # exit code=0: No unused code was found
@@ -133,7 +123,7 @@ check-unused:
   # - 60 %: attribute, class, function, method, property, variable
   # There are some things should be ignored though, with the allowlist.
   # Create an allowlist with `vulture --make-allowlist`
-  uv run vulture --min-confidence 100 src/ tests/ **/vulture-allowlist.py
+  uvx vulture --min-confidence 100 src/ tests/ **/vulture-allowlist.py
 
 # Re-build the README file from the Quarto version
 build-readme:
diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja
@@ -16,6 +16,26 @@ license = "MIT"
 license-files = ["LICENSE.md"]
 requires-python = ">=3.12"
 dependencies = []
+# From https://pypi.org/classifiers/
+classifiers = [
+  "License :: OSI Approved :: MIT License",
+
+  # Strict typing, checked via mypy
+  "Typing :: Typed",
+
+  # How mature is this project? Common values are
+  #   3 - Alpha
+  #   4 - Beta
+  #   5 - Production/Stable
+  "Development Status :: 4 - Beta",
+
+  # Indicate who your project is intended for
+  "Intended Audience :: Developers",
+
+  # Specify the Python versions you support here.
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12",
+]
 
 [project.urls]
 # TODO: Add URLs relevant to the project.
@@ -27,3 +47,12 @@ issues = "https://github.com/{{ github_repo_spec }}/issues"
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
+
+[tool.pytest.ini_options]
+# - A short traceback (tb) mode to make it easier to view
+# - Use the `src/` package (importlib)
+# - Use code coverage on the `src/` package
+# - If tests fail, do not generate coverage report
+# - Create the coverage report in XML (for badge), terminal, and HTML
+# - Trigger failure if below 90% code coverage
+addopts = "--tb=short --import-mode=importlib --cov=src --no-cov-on-fail --cov-report=term --cov-report=xml --cov-report=html --cov-fail-under=90"
diff --git a/template/pytest.ini b/template/pytest.ini

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`		`-<!-- TODO: Set up GoatCounter -->`
`2`	`1`	`<script data-goatcounter="https://seedcase-template-python-package.goatcounter.com/count" async`
`3`	`2`	`src="//gc.zgo.at/count.js"></script>`