PyBootstrap⚓︎

This template sets up a structure for you to write a python package. It comes filled with a bunch of modern features from the python ecosystem.

All Batteries included⚓︎

• Testing setup with pytest
• Pre-commit Hooks, run with Prek
• autogenerated Changelog with Git Changelog or Git Cliff
• Task orchestration with Justfile
• Preconfigured Licenses to choose from
• Documentation from Zensical
• Code Quality assurance with ruff and ty
• CI pipelines for Github Actions and Gitlab
• Fast environment and project management with uv

Usage⚓︎

To install the copier tool with uv run:

$ uv tool install copier --with copier-templates-extensions

To initialize a new repository with the copier template run the following command:

$ copier copy --trust "gh:npikall/py-bootstrap" path/to/project/

You will be prompted and then your repo will be setup.

First Steps⚓︎

After you have just used the copier to create this repo, you might want to run the following commands:

• just init to initialize a git repository
• just dev to create a virtual environment and install the pre-commit hooks