pup-clean: Professional Python Project: Instructor Repo Cleaner

PyPI Docs Site Repo Python 3.15 License

CI Docs-Deploy Pre-Release Release Links Dependabot

pup logo

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 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 generated-artifacts instructor-tooling project-templates python python-projects repository-cleanup teaching-repositories 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_clean-0.1.1.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

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

pup_clean-0.1.1-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file pup_clean-0.1.1.tar.gz.

File metadata

  • Download URL: pup_clean-0.1.1.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

Hashes for pup_clean-0.1.1.tar.gz
Algorithm Hash digest
SHA256 22c4255b5a35bd30d8ca212e4b2164493837573d14d239968ff100c94ac9f60a
MD5 beee1135111ea95a4dbf0b77a4b4eeae
BLAKE2b-256 0652e0f62900c4e94cfbfd553ccc76d5eb99b981b59b9578e5bb35e7dad94eb7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pup_clean-0.1.1.tar.gz:

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

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_clean-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pup_clean-0.1.1-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

Hashes for pup_clean-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0f511aa0c63c1429e294cb0d43b32b190e0ec4b4750ce18088a1bb21aaa4b245
MD5 18c9a2c5e8677db7826c352ab33e24c8
BLAKE2b-256 aacb1ce3ae10ee2f4b5f23a292de630ce231c99d98bf62cb7ddfd37f66386f8c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pup_clean-0.1.1-py3-none-any.whl:

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

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