A template for a python project with uv as package manager, ruff as linter and formatter and ty as typechecker
Find a file Use this template
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-09-22 16:44:57 +02:00
.gitignore Added .gitignore to Template 2026-09-22 16:44:57 +02:00
.woodpecker.yml Created Template 2026-09-20 12:57:26 +02:00
README.md Created Template 2026-09-20 12:57:26 +02:00

python

A cool Python repository.

Installation

You can install uv using pip:

pip install uv

or directly from the source: astral.sh/uv

Usage

After installing uv, you can initialize it using the following command:

uv init

to add a new component, use the following command:

uv add <component_name>

Execute the following command to run uv:

uv run main.py

Linting

To lint your Python code using ruff and typecheck using ty, execute the following commands:

To lint your Python code using ruff.

uvx ruff check

To format your Python code using ruff:

uvx ruff format

for typechecking your Python code using ty:

uvx ty check

CiCD

The Linting and typechecking is also integrated into the CI/CD pipeline to ensure code quality before merging changes. This setup uses Woodpecker CI. The Ci/CD workflow will automatically run the linting and typechecking steps defined in the .woodpecker.yml configuration file.

DISCLAIMER: The Ci/CD workflow just works if a uv init was executed in the repository beforehand. And at least one component has been added using uv add <component_name>.