aarnphm / templ

Opinionated template for Python-based projects.

Checklist

• Rename the folder ./src/package to ./src/<your-package-name>
• Rename package in L14 of SECURITY.md to <your-package-name> and the correct email for vulnerability.
• Update ./.github/CODEOWNERS to include correct CODEOWNERS.
• Update the following field in pyproject.toml:
  • project.name=... -> project.name=<your-package-name>
  • project.description=... -> project.description=<your-package-description>
  • project.authors=... -> project.authors=[{name=<your-name>, email=<your-email>}]
  • tool.hatch.build.hooks.vcs."version-file"=... -> tool.hatch.build.hooks.vcs."version-file"="src/<your-package-name>/_version.py" Consult PEP621 for more information.
• Run bash ./all.sh
• Setup the following secrets:
  • GPG_PRIVATE_KEY
  • GPG_PASSPHRASE
  • PACKAGE_PAT: Personal Access Token with repo scope (you can just use rg to search for all PACKAGE_PAT and rename it to whatever you want)

OPTIONAL

• Change indent-style to 4 if you wish in .editorconfig, .ruff.toml