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

Dry run is the default. Nothing is deleted unless --delete is explicitly provided.

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

Annotations

.annotations/annotations.md

Citation

CITATION.cff

License

MIT

Project links

Data verified by PyPI on Aug 9, 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:
Newer release available (0.1.1)

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 9, 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.0.4.tar.gz (14.6 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.0.4-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pup_clean-0.0.4.tar.gz
  • Upload date:
  • Size: 14.6 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.0.4.tar.gz
Algorithm Hash digest
SHA256 de247a008ef3a3c735d5269c76aac20b8b4a92b9b87b8c055d2dbe172abf073c
MD5 edcaa0041826bf510a6f0f60433e0e47
BLAKE2b-256 f3a4ec8d06abc3d8839f95d6501156dce3ccb9aaf18a6f4ed20ab7f7127d6413

See more details on using hashes here.

Provenance

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

Publisher: release-pypi.yml on denisecase/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.0.4-py3-none-any.whl.

File metadata

  • Download URL: pup_clean-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 13.4 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.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fd56cdc3b30300a5defa3fa92b4a182fc49be13d62c1d37d983baa7c93963073
MD5 2cf097df0de0b9ad74c69601e79a6295
BLAKE2b-256 a28a2448fa125c491dcf70fe4b6487ebe591ad88b3e45100690bd70dc779b31f

See more details on using hashes here.

Provenance

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

Publisher: release-pypi.yml on denisecase/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