pup-check: Professional Python Project: Repo Self Consistency Checker
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 structurepyproject.tomlmetadata- 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.tomlexistspyproject.tomlcan 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/denisecase/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
Citation
License
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pup_check-0.1.0.tar.gz.
File metadata
- Download URL: pup_check-0.1.0.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1989aca09ac93674d512be75600de2a164e514de1ee52f5dae44a348d9f979cb
|
|
| MD5 |
f009219730f90c36de9c011a158938e0
|
|
| BLAKE2b-256 |
b92addd8c5a24d917d2aa62681bb783d32de672694506bbf4c692b7610f634b8
|
Provenance
The following attestation bundles were made for pup_check-0.1.0.tar.gz:
Publisher:
release-pypi.yml on pup-pack/pup-check
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pup_check-0.1.0.tar.gz -
Subject digest:
1989aca09ac93674d512be75600de2a164e514de1ee52f5dae44a348d9f979cb - Sigstore transparency entry: 2408194461
- Sigstore integration time:
-
Permalink:
pup-pack/pup-check@dd5e9fee82aef2d6d0bff7186515717784e740dc -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/pup-pack
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-pypi.yml@dd5e9fee82aef2d6d0bff7186515717784e740dc -
Trigger Event:
push
-
Statement type:
File details
Details for the file pup_check-0.1.0-py3-none-any.whl.
File metadata
- Download URL: pup_check-0.1.0-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
64ce0c259c0cdc3aea0c03a48d0210e9a80556e7a5f553a0190e5de101a7a735
|
|
| MD5 |
236e4b523ddde7f666727d828f3bf4ea
|
|
| BLAKE2b-256 |
4d58d3f95d661cf07ddca6f8d24c147f516fbc8f29f514b403b4c944b67049f2
|
Provenance
The following attestation bundles were made for pup_check-0.1.0-py3-none-any.whl:
Publisher:
release-pypi.yml on pup-pack/pup-check
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pup_check-0.1.0-py3-none-any.whl -
Subject digest:
64ce0c259c0cdc3aea0c03a48d0210e9a80556e7a5f553a0190e5de101a7a735 - Sigstore transparency entry: 2408194503
- Sigstore integration time:
-
Permalink:
pup-pack/pup-check@dd5e9fee82aef2d6d0bff7186515717784e740dc -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/pup-pack
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-pypi.yml@dd5e9fee82aef2d6d0bff7186515717784e740dc -
Trigger Event:
push
-
Statement type:
