packright

Automate Python package development the right way — inspired by R's usethis.

Installation

pip install packright

Quickstart

# Create a new package with all conventions in place
packright scaffold my-analytics-lib
cd my-analytics-lib
uv sync
uv run pytest

This creates a complete package with src/ layout, errors.py, _messages.py, tests, docs, CI — all conventions in place, passing 22/22 checks.

Commands

Create

Configure

Integrate

Manage

Inspect

Examples

# Start from scratch
packright scaffold my-lib
cd my-lib

# Or add to an existing project piece by piece
packright use-pytest
packright use-ruff
packright use-pre-commit
packright use-github-actions

# Check what's missing
packright check

# Add a new feature module
packright use-module auth

# Bump version and release
packright bump-version minor
git tag v0.2.0
git push --tags  # CI publishes to PyPI

Philosophy

packright follows the python-package-development skill conventions — 5 principles from R's package ecosystem applied to Python:

1. User communication is first-class — rich, not print()
2. Function names form a grammar — verb_noun() patterns
3. Lifecycle deserves ceremony — formal deprecation process
4. Documentation lives next to code — Google docstrings + mkdocs
5. There is a whole game — scaffold first, refine later