pup-check: Professional Python Project: Repo Self Consistency Checker

PyPI Docs Site Repo Python 3.15 License

CI Docs-Deploy Pre-Release Release Links Dependabot

pup logo

Opinionated professional Python repository self-consistency checker

Purpose

Professional Python repositories contain many declarations that should agree with one another.

Examples include:

  • project and package names
  • src/ package structure
  • pyproject.toml metadata
  • command-line entry points
  • Python module paths
  • dependency declarations
  • Python version declarations
  • repository-relative file paths
  • workflow and tooling configuration

Small inconsistencies can remain unnoticed until a command, build, test, documentation workflow, or release fails.

pup-check performs deterministic checks for internal repository consistency and reports problems that should be reviewed.

Check a Repository

# check the current repository
uvx pup-check

# check using the latest published version
uvx pup-check@latest

A successful check returns exit code 0.

A failed consistency check returns a nonzero exit code and reports the detected problem.

Checks

This release checks:

  • pyproject.toml exists
  • pyproject.toml can be read and identifies the project
  • a Python package can be detected when a src/ layout is present
  • modules referenced by [project.scripts] entry points exist

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

cd pup-check
code .

In a VS Code terminal

uv self update
uv python pin 3.15
uv lock --upgrade
uv sync --upgrade
# if concurrent dev:
uv pip install -e ../pup-core

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-check
uv run pup-check --diff
uv run pup-check --write
uv run pup-check --write .gitattributes .github/.yamllint.yml .github/workflows/links.yml

# types, tests, docs
uv run python -m pyright
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

Project links

Data verified by PyPI on Aug 10, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for denisecase from gravatar.com denisecase

Credits

Author: Denise Case

GitHub Statistics

Data verified by PyPI on Aug 10, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.15

Tags

automation command-line-tool developer-tooling project-validation python python-projects repository-consistency software-architecture software-quality uvx

Classifiers

Report project as malware

Download files

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

Source Distribution

pup_check-0.1.2.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

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

pup_check-0.1.2-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file pup_check-0.1.2.tar.gz.

File metadata

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

File hashes

Hashes for pup_check-0.1.2.tar.gz
Algorithm Hash digest
SHA256 c864c5c8112822b0333a534880de904cb7406b329702afd49155e9d5b4a01692
MD5 a9283799a7a7ed2495517d2ad63cb17e
BLAKE2b-256 2095b709ace2609e8a94fd990c6d5378a8262d7e6627cc68106e1bec8420056b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pup_check-0.1.2.tar.gz:

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

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_check-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pup_check-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 10.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_check-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6b11a3be53dc32576c7680be80f024ae4be6f3bd5563f7f5339f0f882e1e7bab
MD5 27e4b6f2a947f6bead2128c2392f4f60
BLAKE2b-256 caa8795b9e3e387acb67757a951aa98d19c904e56df45637df8dd6d606775deb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pup_check-0.1.2-py3-none-any.whl:

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

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

Supported by

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