UV Package Blueprint

Tecnology stack

• uv for python and project manager
• pre-commit with ruff to mantain code consistency and pre-commit checks
• GitHub Actions to create release and publish package (also on a private registry)

Usage

Note: You need uv (and uv only) installed on your machine.

To create a package using this repo as template, install copier as an uv tool:

uv tool install copier

Then proceed with creating the package and answer the prompted questions:

copier copy https://github.com/lanzani/package-blueprint path/to/destination

Update

You can update a child repo that has been created with this template by running:

copier update

Setup GitHub Actions

If you are not going to publish your package on a private index you can skip this section! Everything is already configured, happy coding!

If you want to publish on a private index that needs authentication you have to declare two secrets in your project's action settings:

• UV_PUBLISH_USERNAME
• UV_PUBLISH_USERNAME

Once done, you are good to go.

:)

TODO

• Publish package on pypi
• Command "magic.py login" to store credentials