Skip to main content

pup-down: Professional Python Project Updater (Move Updates Down to Templates)

PyPI Docs Site Repo Python 3.15 uv managed ty type checked Zensical docs MIT

CI Docs-Deploy Pre-Release Release Links Dependabot

pup logo

Opinionated professional Python project template comparison tool. Shows when the active repo has more recent infrastructure files that should possibly be copied to the canonical templates.

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-down makes it easy to identify infrastructure improvements made during recent work that should possibly be copied back to the canonical templates.

Benefits

pup-down is report-only. Each repository fetches the current baseline and compares it with its own infrastructure. Nothing reaches in from a central place, so:

  • Repo owner is in control. Run it when you choose. No files are updated. A list of changes to possibly copy to the canonical template files is provided.

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

Compare a Repo with Templates

# compare with canonical templates
uvx pup-down

# compare using the latest published pup-down version
uvx pup-down@latest

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-down

cd pup-down
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-down

# 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

Annotations

.annotations/annotations.md

Citation

CITATION.cff

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pup_down-0.1.0.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pup_down-0.1.0-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file pup_down-0.1.0.tar.gz.

File metadata

  • Download URL: pup_down-0.1.0.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pup_down-0.1.0.tar.gz
Algorithm Hash digest
SHA256 989aa80b73e0d02cf5a1fd0021f5caa8d7d6262d729f7087f4fd1e3acabe1c79
MD5 27966afe4f79ffd54a84c84c67d34e98
BLAKE2b-256 d60f8f9e0b26ae2d15290542944d5ecfd4793687c31e60d1304ee200d8aad28f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pup_down-0.1.0.tar.gz:

Publisher: release-pypi.yml on pup-pack/pup-down

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pup_down-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pup_down-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pup_down-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a176c19c2f7dd088f60fc2dea0977a219a551349100060f491d3490409c12cb8
MD5 d1ca7e3f6374caff3f2c8f833cca093b
BLAKE2b-256 bcaeb618ad083838f13f41b4b0953c0f438d02d1ab97de8566bc260e975bc9dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for pup_down-0.1.0-py3-none-any.whl:

Publisher: release-pypi.yml on pup-pack/pup-down

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.2.0

2 files

This release

0.1.0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page