python-template

A template repository for building a Python package with the src layout.

python-template/
├── src/
│   └── my_package/
│       ├── __init__.py
│       └── core.py
├── tests/
│   ├── __init__.py
│   └── test_core.py
├── pyproject.toml
└── .gitignore

1. Rename the package — replace every occurrence of my_package / my-package with your package name.

2. Install in editable mode:

   pip install -e ".[dev]"

3. Run tests:

   pytest

4. Lint / format:

   ruff check src tests
   ruff format src tests

• Source code lives under src/<your_package>/
• Add runtime dependencies to [project] dependencies in pyproject.toml
• Add dev/test dependencies to [project.optional-dependencies] dev