template-python-uv-package 0.1.0

Opinionated Python + uv template for new packages.

template-python-uv-package

Opinionated Python + uv template for new packages.

• Source code
• PyPI package
• ClickPy
• ecosyte.ms
• Libraries.io
• Open Source Insights
• OSV
• PePy
• PyPack Trends
• PyPI Stats
• Snyk
• Socket

Getting Started

1. Go to or create the package folder.
2. Get the template files:

npx giget@3.2.0 github:joaopalmeiro/template-python-uv-package . --force

3. Search for template-python-uv-package and replace it with the package name. Ignore the template repository URL in the NOTES.md file.
4. Search for template_python_uv_package and replace it with the underscored version of the package name.
5. Search for Opinionated [Python](https://www.python.org/) + [uv](https://github.com/astral-sh/uv) template for new packages./Opinionated Python + uv template for new packages. and replace it with the (short) package description.
6. Search for João Palmeiro and replace it with the author's name.
7. Search for [e-mail] and replace it with the author's email address.
8. Update the Source code link at the top to the package repository link (if necessary).
9. Change GitHub in the Deployment section to GitLab or Codeberg and update the link to the corresponding Tags page (if necessary).
10. Update the Issues and Source fields in the pyproject.toml file with their respective repository-related links (if necessary).
11. Delete the TEMPLATE.md file.
12. Delete the Getting Started section.

Development

Install uv, zizmor, and pinact (if necessary):

curl -LsSf https://astral.sh/uv/0.11.6/install.sh | sh

uv python install

uv audit --verbose

uv run python -c "from template_python_uv_package import __version__; print(__version__)"

uv run mypy

uv run ruff format

uv run ruff check --fix

uv build

GitHub Actions

zizmor .

pinact run -u --min-age 7

Deployment

• Create the release GitHub Actions environment (if necessary).
• Add a trusted publisher to an existing PyPI project or create a new one with a trusted publisher (if necessary).

uv version --bump patch

uv version --bump minor

uv version --bump major

echo "v$(uv version --short)" | pbcopy

• Commit and push changes.
• Create a tag on GitHub Desktop.
• Check GitHub.
• Check PyPI.