pup-clean: Professional Python Project: Instructor Repo Cleaner
Opinionated professional Python repository cleaner
Purpose
pup-clean prepares instructor repositories for release as student project
templates.
It removes known disposable development artifacts and inspects project source code to discover generated data, database, and image artifacts that should not be included in the student version of the repository.
Dry run is the default.
Nothing is deleted unless --delete is provided.
Clean a Repository
# see what would be removed (dry run, the default)
uvx pup-clean
# use the latest published version
uvx pup-clean@latest
# remove all detected generated artifacts (CAUTION: DESTRUCTIVE)
uvx pup-clean --delete
# preview only specified cleanup targets
uvx pup-clean project.log data/prepared/sales.csv
# delete only specified detected cleanup targets (CAUTION: DESTRUCTIVE)
uvx pup-clean --delete project.log data/prepared/sales.csv docs/images/sales_by_region.png
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-clean
cd pup-clean
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 and see all detected cleanup targets
uv run pup-clean
# delete all detected cleanup targets (CAUTION: DESTRUCTIVE)
uv run pup-clean --delete
# preview only specified cleanup targets
uv run pup-clean project.log data/prepared/sales.csv
# delete only specified detected cleanup targets (CAUTION: DESTRUCTIVE)
uv run pup-clean --delete project.log data/prepared/sales.csv docs/images/sales_by_region.png
# 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
Citation
License
1 maintainer
Release files for pup-clean 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pup_clean-0.1.3.tar.gz | 14.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pup_clean-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.2 kB
Release files / pup_clean-0.1.3.tar.gz
| Download URL | pup_clean-0.1.3.tar.gz |
|---|---|
| Size | 14.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bcb95727b15ef05f3fc5d378b2abc938ecb494fd0367e593c35e96255f086d05
|
|
BLAKE2b-256 checksum How to use checksums |
26437eddfd10c30809cf11b911d6df2ce8b0ffc9e7fe466c4d6e52569b6e15aa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 14, 2026.
Transparency logRelease files / pup_clean-0.1.3-py3-none-any.whl
| Download URL | pup_clean-0.1.3-py3-none-any.whl |
|---|---|
| Size | 12.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c53fa24832cf83d88212165a3cdfee4faf562d2c56928902a5fe0aa0e8c10ce4
|
|
BLAKE2b-256 checksum How to use checksums |
ba0873c2a79516391dc1c9bf0c2fe4e9c584ab997dff2f9194b9c4b9e9401f01
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 14, 2026.
Transparency log
