Skip to content

Commit 9ea6c4b

Browse files
authored
Merge branch 'main' into refactor/move-config-file-into-config-folder
2 parents e4d4c05 + c63f4b6 commit 9ea6c4b

10 files changed

Lines changed: 68 additions & 25 deletions

File tree

404.qmd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Let's get you back to greener grounds.
66

77
👉 Go to [homepage](/index.qmd).
88

9-
![](/_extensions/seedcase-project/seedcase-theme/images/404.svg){fig-alt="An illustration of the number 404 surrounded by trees and mountains"}
9+
![](/_extensions/seedcase-project/seedcase-theme/images/404.svg){fig-alt="An
10+
illustration of the number 404 surrounded by trees and mountains"}
1011

1112
## Illustration by [Storyset](https://storyset.com/online) {.appendix}

CHANGELOG.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,39 @@ within each release.
2222
Commits from bots, like `dependabot` or `pre-commit-ci`, are not
2323
included in the changelog.
2424

25+
## [0.23.0](https://github.com/seedcase-project/template-python-package/compare/0.22.3..0.23.0) - 2026-05-22
26+
27+
### ✨ Features
28+
29+
- Add `pyproject.toml` classifiers for better discoverability
30+
[#290](https://github.com/seedcase-project/template-python-package/pull/290)
31+
by [`@lwjohnst86`](https://github.com/lwjohnst86)
32+
([fd37f23](https://github.com/seedcase-project/template-python-package/commit/fd37f23ad574d992566e6f85808f11f28e2852dc))
33+
34+
## [0.22.3](https://github.com/seedcase-project/template-python-package/compare/0.22.2..0.22.3) - 2026-05-22
35+
36+
### ♻️ Refactor
37+
38+
- Remove Conventional Commit scopes and use raw emoji
39+
[#283](https://github.com/seedcase-project/template-python-package/pull/283)
40+
by [`@lwjohnst86`](https://github.com/lwjohnst86)
41+
([03ab0ba](https://github.com/seedcase-project/template-python-package/commit/03ab0ba6d9b8dbbf6ade4232b4458dc5fc913902))
42+
- Remove `build-pdf` from justfile, not needed anymore
43+
[#288](https://github.com/seedcase-project/template-python-package/pull/288)
44+
by [`@lwjohnst86`](https://github.com/lwjohnst86)
45+
([3ca4fe5](https://github.com/seedcase-project/template-python-package/commit/3ca4fe5277ebfe6806e5b7db7cbbe361cec63a7d))
46+
- Switch to using `uvx` for dev tooling, `uv run` isn't needed
47+
[#285](https://github.com/seedcase-project/template-python-package/pull/285)
48+
by [`@lwjohnst86`](https://github.com/lwjohnst86)
49+
([126dca2](https://github.com/seedcase-project/template-python-package/commit/126dca25c77882ad4188a330c504587e7eb7a680))
50+
51+
### 📝 Documentation
52+
53+
- Minor clean up of docs
54+
[#286](https://github.com/seedcase-project/template-python-package/pull/286)
55+
by [`@lwjohnst86`](https://github.com/lwjohnst86)
56+
([73f4bb6](https://github.com/seedcase-project/template-python-package/commit/73f4bb69f0ce9565c1bd40ba3cb38eb55e79a693))
57+
2558
## [0.22.2](https://github.com/seedcase-project/template-python-package/compare/0.22.1..0.22.2) - 2026-05-19
2659

2760
### ♻️ Refactor

docs/includes/site-counter.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
<!-- TODO: Set up GoatCounter -->
21
<script data-goatcounter="https://seedcase-template-python-package.goatcounter.com/count" async
32
src="//gc.zgo.at/count.js"></script>

index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: An opinionated template for Python Packages
2+
title: "{{< meta tagline >}}"
33
---
44

55
{{< include /docs/includes/_badges.qmd >}}

template/.github/dependabot.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,10 @@ updates:
66
interval: monthly
77
commit-message:
88
prefix: ci
9-
include: scope
109

1110
- package-ecosystem: uv
1211
directory: /
1312
schedule:
1413
interval: monthly
1514
commit-message:
1615
prefix: build
17-
include: scope

template/.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# See https://pre-commit.com for more information
22
# See https://pre-commit.com/hooks.html for more hooks
33
ci:
4-
autofix_commit_msg: "chore(pre-commit): :pencil2: automatic fixes"
5-
autoupdate_commit_msg: "ci(pre-commit): :construction_worker: update pre-commit CI version"
4+
autofix_commit_msg: "chore: ✏️ automatic pre-commit hook fixes"
5+
autoupdate_commit_msg: "ci: 👷 update pre-commit CI version"
66

77
repos:
88
- repo: https://github.com/gitleaks/gitleaks

template/.vscode/settings.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,7 @@
3636
"python.testing.pytestPath": "${workspaceFolder}/.venv/bin/pytest",
3737
"mypy.runUsingActiveInterpreter": true,
3838
"ruff.configuration": ".config/ruff.toml",
39-
"mypy.configFile": ".config/mypy.ini"
39+
"mypy.configFile": ".config/mypy.ini",
40+
"conventionalCommits.emojiFormat": "emoji",
41+
"conventionalCommits.promptScopes": false
4042
}

template/TODO.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
after copying the project.
55
- Run `git init -b main` to create the project as a Git repository.
66
- Install these packages
7-
`uv add --dev pre-commit ruff typos pytest bandit commitizen genbadge jupyter pytest-cov quartodoc types-tabulate mypy vulture`
7+
`uv add --dev pytest genbadge jupyter pytest-cov quartodoc quarto types-tabulate mypy`
88
- Run `just list-todos` and complete all the TODO items.
99
- Run `just install-precommit` to install the pre-commit hooks.
1010
- Run `just build-readme` to build the Markdown version of the README.

template/justfile.jinja

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,14 @@ test-python:
5454
# Check Python code for any errors that need manual attention
5555
check-python:
5656
# Check formatting
57-
uv run ruff check . --config .config/ruff.toml
57+
uvx ruff check . --config .config/ruff.toml
5858
# Check types
5959
uv run mypy --pretty . --config-file .config/mypy.ini
6060

6161
# Reformat Python code to match coding style and general structure
6262
format-python:
63-
uv run ruff check --fix . --config .config/ruff.toml
64-
uv run ruff format . --config .config/ruff.toml
63+
uvx ruff check --fix . --config .config/ruff.toml
64+
uvx ruff format . --config .config/ruff.toml
6565

6666
# Format Markdown files
6767
format-md:
@@ -99,11 +99,11 @@ check-commits:
9999

100100
# Run basic security checks on the package
101101
check-security:
102-
uv run bandit -r src/
102+
uvx bandit -r src/
103103

104104
# Check for spelling errors in files
105105
check-spelling:
106-
uv run typos
106+
uvx typos
107107

108108
# Install lychee from https://lychee.cli.rs/guides/getting-started/
109109
# Check that URLs work
@@ -113,16 +113,6 @@ check-urls:
113113
--extensions md,qmd,py \
114114
--exclude-path "_badges.qmd"
115115

116-
# Build the documentation as PDF using Quarto
117-
build-pdf:
118-
# To let Quarto know where python is.
119-
export QUARTO_PYTHON=.venv/bin/python3
120-
uv run quarto install tinytex
121-
# For generating images from Mermaid diagrams
122-
uv run quarto install chromium
123-
uv run quarto render --profile pdf --to pdf
124-
find docs -name "mermaid-figure-*.png" -delete
125-
126116
# Check for unused code in the package and its tests
127117
check-unused:
128118
# exit code=0: No unused code was found
@@ -133,7 +123,7 @@ check-unused:
133123
# - 60 %: attribute, class, function, method, property, variable
134124
# There are some things should be ignored though, with the allowlist.
135125
# Create an allowlist with `vulture --make-allowlist`
136-
uv run vulture --min-confidence 100 src/ tests/ **/vulture-allowlist.py
126+
uvx vulture --min-confidence 100 src/ tests/ **/vulture-allowlist.py
137127

138128
# Re-build the README file from the Quarto version
139129
build-readme:

template/pyproject.toml.jinja

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,26 @@ license = "MIT"
1616
license-files = ["LICENSE.md"]
1717
requires-python = ">=3.12"
1818
dependencies = []
19+
# From https://pypi.org/classifiers/
20+
classifiers = [
21+
"License :: OSI Approved :: MIT License",
22+
23+
# Strict typing, checked via mypy
24+
"Typing :: Typed",
25+
26+
# How mature is this project? Common values are
27+
# 3 - Alpha
28+
# 4 - Beta
29+
# 5 - Production/Stable
30+
"Development Status :: 4 - Beta",
31+
32+
# Indicate who your project is intended for
33+
"Intended Audience :: Developers",
34+
35+
# Specify the Python versions you support here.
36+
"Programming Language :: Python :: 3",
37+
"Programming Language :: Python :: 3.12",
38+
]
1939

2040
[project.urls]
2141
# TODO: Add URLs relevant to the project.

0 commit comments

Comments
 (0)