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/denisecase/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 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_clean-0.1.0.tar.gz.
File metadata
- Download URL: pup_clean-0.1.0.tar.gz
- Upload date:
- Size: 14.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9df9a7aae76cb6ed492cf2fa73da001a522bffbf7e6f4b48d873645449a691e2
|
|
| MD5 |
7e43afb66a35cf0eeea1f17b6556bc19
|
|
| BLAKE2b-256 |
02943e3d79b2e7eea5a7c4dc0709902512a76674382854906bbfa19d41955aa4
|
Provenance
The following attestation bundles were made for pup_clean-0.1.0.tar.gz:
Publisher:
release-pypi.yml on pup-pack/pup-clean
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pup_clean-0.1.0.tar.gz -
Subject digest:
9df9a7aae76cb6ed492cf2fa73da001a522bffbf7e6f4b48d873645449a691e2 - Sigstore transparency entry: 2408194880
- Sigstore integration time:
-
Permalink:
pup-pack/pup-clean@dc59ad9272c6869ec07ee38924ffe04f4375517c -
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@dc59ad9272c6869ec07ee38924ffe04f4375517c -
Trigger Event:
push
-
Statement type:
File details
Details for the file pup_clean-0.1.0-py3-none-any.whl.
File metadata
- Download URL: pup_clean-0.1.0-py3-none-any.whl
- Upload date:
- Size: 12.8 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 |
394f61c2baf5743bccedad78e8c428fed3ae3a8077a345a7e8ca890a4ff59d30
|
|
| MD5 |
a89bb187df9915e453559a0dbbde9948
|
|
| BLAKE2b-256 |
7493d9626f2eaaf269481c16790ee3781c368d0f95f5622a6af60dec46965a48
|
Provenance
The following attestation bundles were made for pup_clean-0.1.0-py3-none-any.whl:
Publisher:
release-pypi.yml on pup-pack/pup-clean
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pup_clean-0.1.0-py3-none-any.whl -
Subject digest:
394f61c2baf5743bccedad78e8c428fed3ae3a8077a345a7e8ca890a4ff59d30 - Sigstore transparency entry: 2408194910
- Sigstore integration time:
-
Permalink:
pup-pack/pup-clean@dc59ad9272c6869ec07ee38924ffe04f4375517c -
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@dc59ad9272c6869ec07ee38924ffe04f4375517c -
Trigger Event:
push
-
Statement type:
