plombier 0.0.1

Bitoduc library

Say Hello!

Python Package Template using UV

Getting Started

1. You need to have UV installed. You can find instructions here.

2. Create the virtual environment

uv venv # create env .venv
uv sync # install dependencies

3. Start developping :

• Add your library code in the src/ directory
• Write tests in the tests/ directory
• Add your license
• Update pyproject.toml with your package information

4. In order to commit you need to :
   • Have no error from linter (ruff)
   • Pass all tests (pytest)

Development Workflows

Code Quality

To ensure a certain level of code quality, Ruff is used.

Configuration can be found in pyproject.toml.

Test

Tests must be write in tests and follow the convention of pytest

Scripts

All automation scripts are defined in noxfile.py file.

To run them use the following commands :

nox                   # Run all scripts
nox -s <script_name>  # Run a scpecific script

Available scripts :

• lint : Check the codebase respect all linting and format rules
• clean : Delete build directory dist
• tests : Run tests from tests folder with python version from 3.9 to 3.13

You can list them with nox --list.

See Nox documentation if you want to know more.

Publishing your package

Automatic Publishing

Your package is automatically published when you push to:

• main branch → Published to PyPI
• dev branch → Published to TestPyPI

Manual Publishing

You can also publish it manually with the following commands :

uv publish --token YOUR_PYPI_TOKEN
# OR
uv publish --index testpypi --token YOUR_TEST_PYPI_TOKEN

Installing your package

Once published, your package can be installed with:

uv add your-package-name
uv add --default-index https://test.pypi.org/simple/ your-package-name # For testing

Or use pip :

pip install your-package-name
pip install --index-url https://test.pypi.org/simple/ your-package-name # For testing

Links

• UV Documentation
• Ruff Documentation
• pytest Documentation
• Nox Documentation
• Python Packaging Guide