Skip to content

Latest commit

 

History

History

bootstrap-python-project

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

Skill: bootstrap a new Python project

Scaffold a new Python project ready to install, type-check, test, and release on day one — not a bare uv init. A modern src/ layout with PEP 621 metadata, dynamic VCS versioning, a py.typed marker, quality tooling, and hardened CI — the shape the tiran/* reference repos ship.

Covers hatchling + hatch-vcs (pure Python, the default) and meson-python + vcs-versioning / scikit-build-core / maturin (compiled), ruff (lint + format), a type checker (Pyrefly by default; ty or mypy on request), pytest + coverage, tox (or nox) driven by uv, and GitHub Actions CI hardened per secure-python-release-pipeline (SHA-pinned, least-privilege, build-and-inspect-python-package, CodeQL, Scorecard, Dependabot, PyPI Trusted Publisher + attestations). Always writes a README, a LICENSE file, and a .gitignore. Type checker, task runner, license, and docs generator are decided with the user (see reference/tooling-choices.md).

Status: Experimental — encodes one house style plus current PyPA / Astral / Hynek Schlawack practice; review the generated tree and first CI run.

Layout

File Role
SKILL.md The 10-step workflow + frontmatter. Source of truth.
AGENTS.md Cross-agent entry point (Codex and other AGENTS.md-aware agents).
reference/scaffold.md Concrete file contents: pyproject.toml (pure + compiled), tox.ini / noxfile.py, ruff/pytest/coverage config, CI workflows, .gitignore, SECURITY.md.
reference/tooling-choices.md The open decisions: type checker (Pyrefly/ty/mypy), license (permissive vs copyleft), tox vs nox, and template tools (recommended scientific-python/cookie; copier, cookiecutter/cruft, uv init/hatch new).
reference/task-runners.md The full task-runner rationale: nox vs tox benefits, and why not make / shell scripts (portability, env isolation, footguns).
reference/containers.md Container house rule (if used): OCI-standard, Podman+Docker tool-agnostic, ARG over hard-coded values, avoid dockerisms, Dev Container standard.

Related

This skill orchestrates these:

Further reading

Acknowledgments

This skill distills the work of many people and projects:

See ../reference-repos.md for the full grounding list.

See the repository README.md for per-agent setup.