Skip to main content

pup-down: Reports Repo Infrastructure Changes That Belong in 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

Report-only. Compares the active repository's infrastructure against canonical templates and lists the files the repo has moved ahead on that may be worth copying back upstream.

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

Default Template Source

Compare a Repo with Templates

# compare with canonical templates
uvx pup-down@latest

# 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.2.0.tar.gz (11.9 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.2.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pup_down-0.2.0.tar.gz
  • Upload date:
  • Size: 11.9 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.2.0.tar.gz
Algorithm Hash digest
SHA256 8aa2c3cd8ab60ff86ff5a9bd47f18851013867115eb6772cd74682f53b655afb
MD5 338c0def5ca84eab70ebb8d62af417f7
BLAKE2b-256 fe5c7c61f997094790ba709a2ebb5d74e3e6838f0eba3389a95c5d113fa61b44

See more details on using hashes here.

Provenance

The following attestation bundles were made for pup_down-0.2.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.2.0-py3-none-any.whl.

File metadata

  • Download URL: pup_down-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.9 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1b571dd54fde3215ecfe466cfb441571e4a1768846e00f9ed74290d960730b0
MD5 eb89c8ab2b00f3d2b76a696c652cec0f
BLAKE2b-256 5ffc0fca1a02939faf2c778cb603f631360773321824bf5b162c68823067a8ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for pup_down-0.2.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

This release

0.2.0 This release

2 files

0.1.0

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