pup-up: Professional Python Project Updater

Opinionated professional Python project template synchronizer

Purpose

Professional Python repositories commonly share infrastructure such as:

• editor and Git configuration
• ignore and line-ending rules
• Markdown, YAML, and link checking
• formatting, linting, type checking, and testing
• documentation tooling
• continuous integration
• package and release validation

pup-up makes it easy to keep the infrastructure files commonly used in professional projects current and consistent.

Benefits

pup-up is pull-based. Each repository fetches the current baseline and applies it on its own terms. Nothing reaches in from a central place, so:

• Repo owner is in control. Run it when you choose. The default is a dry run; nothing is written until you pass --write.
• See before accept. --diff shows exactly what would change, line by line, before any file is touched.
• Blast radius is one repo. A template change is applied per repository.
• Local differences survive. A repo that needs to diverge just doesn't take a specific file. Templates offer an optional baseline, never a mandate.

Templates are fetched by immutable commit SHA, so an update always reflects the latest push to the template repository and every run is pinned to an exact template commit.

Repo type is inferred from the presence of key files so no extensive configuration is needed. For example:

• ALL REPOS
• pyproject.toml indicates ALL PY REPOS
• pyproject.toml + src indicates ALL PY SRC REPOS

Template Source

• templates

Update a Repo based on Templates

# see what files would change (dry run, the default)
uvx pup-up

# see what files the command would update (dry run, force latest version)
uvx pup-up@latest

# see exactly what would change, line by line
uvx pup-up --diff

# add and overwrite all the files listed (CAUTION: DESTRUCTIVE)
uvx pup-up --write

# add and overwrite only specific files listed (CAUTION: DESTRUCTIVE)
uvx pup-up --write .gitattributes .github/.yamllint.yml .github/workflows/links.yml

Developer Command Reference

Show command reference

In a machine terminal

Open a machine terminal where you want the project:

git clone https://github.com/pup-pack/pup-up

cd pup-up
code .

In a VS Code terminal

uv self update
uv python pin 3.15
uv python install
uv lock --upgrade
uv sync

uv run pre-commit install
uv run pre-commit autoupdate

git add -A
uv run pre-commit run --all-files
# repeat if changes were made
uv run pre-commit run --all-files

# run locally to test
uv run pup-up
uv run pup-up --diff
uv run pup-up --write
uv run pup-up --write .gitattributes .github/.yamllint.yml .github/workflows/links.yml

# types, tests, docs
uv run ty check
uv run python -m pytest
uv run python -m zensical build

# save progress
git add -A
git commit -m "update"
git push -u origin main

Documentation

• Documentation

Annotations

.annotations/annotations.md

Citation

CITATION.cff

License

MIT