← Return to KIR Training Catalogue

🚧 Work in Progress

This repository is under active development.
Expected completion: 20th of May 2026

01

Project structure

pyproject.toml & the src/ layout

~45 min

• pyproject.toml vs setup.py
• The src/ layout pattern
• Package metadata & configuration
• Installing in editable mode

You'll create

A basic installable package

02

CLI tools

Entry points & argument parsing

~30 min

• Console scripts & entry points
• Command-line argument parsing
• Building user-friendly CLIs

You'll create

CLI tools for sequence analysis

03

Dependencies

Environments & dependency management

~40 min

• Specifying dependencies in pyproject.toml
• Optional dependencies & extras
• Virtual environment best practices
• Lock files & reproducibility

You'll create

A properly managed dependency structure

04

Testing & quality

pytest, ruff, mypy & pre-commit

~50 min

• Adding tests with pytest
• Code formatting with ruff/black
• Type checking with mypy
• Pre-commit hooks for automation

You'll create

A tested, quality-controlled package

05

Distribution

Building, versioning & publishing to PyPI

~45 min

• Building wheels & source distributions
• Version management strategies
• Publishing to PyPI

You'll create

A published, documented package

05.b

Distribution

Documentation

~45 min

• Documentation with mkdocs-material

You'll create

A published, documented package

---

Supplementary

S.01

Rich Text

Richer CLI outputs with rich

~30 min

• add colors, tables, & formatted output to your command-line interface.

You'll create

Elevated CLI for pypackges