diff --git a/.claude/scripts/test_setup_script_docs.sh b/.claude/scripts/test_setup_script_docs.sh deleted file mode 100755 index 77bab7d..0000000 --- a/.claude/scripts/test_setup_script_docs.sh +++ /dev/null @@ -1,21 +0,0 @@ -#!/usr/bin/env bash -# Copy the repository, run setup_project.sh with a new name and build the docs site of the copy, -# to check that the rename reaches the Astro config and the API pages. -set -euo pipefail -REPO="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)" -PYTHON="${PYTHON:-$REPO/.venv/bin/python}" -WORK="$(mktemp -d)" -trap 'rm -rf "$WORK"' EXIT -rsync -a --exclude .git --exclude node_modules --exclude dist --exclude .astro --exclude .venv "$REPO/" "$WORK/" -cd "$WORK" -bash setup_project.sh my-test-app -grep -q "const pythonPackage = 'my_test_app'" docs/astro.config.mjs -grep -q "/api/my_test_app/" docs/src/components/Header.astro -grep -q "/api/my_test_app/index.html" .github/workflows/docs.yml -grep -q "src/my_test_app/__init__.py" release-please-config.json -grep -q "source = \[ \"my_test_app\" \]" pyproject.toml -grep -q "from my_test_app.main import main" docs/src/content/docs/getting-started/quickstart.md -cp -cR "$REPO/docs/node_modules" docs/node_modules 2>/dev/null || cp -R "$REPO/docs/node_modules" docs/node_modules -cd docs && DOCS_PYTHON="$PYTHON" npm run build 2>&1 | tail -25 -test -f dist/api/my_test_app/main/index.html -echo "setup script + docs build: OK" diff --git a/CITATION.cff b/CITATION.cff deleted file mode 100644 index 1211afe..0000000 --- a/CITATION.cff +++ /dev/null @@ -1,12 +0,0 @@ -cff-version: 1.2.0 -message: If you use this software, please cite it as below. -type: software -title: template-python -authors: - - family-names: Lindqvist - given-names: Max -version: 0.1.0 -date-released: "2026-10-05" -repository-code: https://github.com/max-models/template-python -url: https://max-models.github.io/template-python/ -license: MIT diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index a07fe47..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,48 +0,0 @@ -# Contributing - -Thanks for taking the time to contribute. - -## Set up - -```bash -git clone https://github.com/max-models/template-python.git -cd template-python -make install # uv sync with the dev extra and the pre-commit hooks -``` - -Without uv: - -```bash -python -m venv env && source env/bin/activate -pip install -e ".[dev]" -pre-commit install -``` - -## Develop - -- Format and lint with [ruff](https://docs.astral.sh/ruff/); the pre-commit hooks run it for you. -- Type-check with `pyright src/`. -- Add tests under `src//tests/` and run `pytest .`. -- Every public module, class and function needs a Google-style docstring. They are rendered - in the API reference and checked by ruff's `D` rules. -- Preview the documentation with `make docs-dev`; see the - [docs guide](https://max-models.github.io/template-python/development/docs/). - -## Commit messages - -Commits follow [Conventional Commits](https://www.conventionalcommits.org/): -`feat:`, `fix:`, `docs:`, `chore:`, `refactor:`, `test:`, `ci:`. A `feat!:` or a -`BREAKING CHANGE:` footer marks a breaking change. Before a release, update the package version -and changelog manually. - -## Pull requests - -Open the PR against `devel`. CI runs the tests on every supported Python version, ruff, pyright, -the tutorials and the documentation build. One approving review is required to merge. - -## Releases - -Before merging a release to `main`, update the versions in `pyproject.toml`, -`src/app/__init__.py` and `CITATION.cff` (including its release date), and add the release -notes to `CHANGELOG.md`. The push creates a GitHub release with a version tag and publishes the -package to PyPI.