cleanpy is a CLI tool to remove caches and temporary files that related to Python.
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
Introduction
cleanpy is a CLI tool to remove caches and temporary files related to Python.
Installation
Installation: pip
pip install cleanpy
Installation: snap
sudo snap install cleanpy
Usage
cleanpy DIR_PATH [DIR_PATH ...]
cleanpy will remove cache files and temporary files under the DIR_PATH.
Removing files or directories targets are as follows:
- Files to be deleted:
*.pyc
*.pyo
- Directories to be deleted:
__pycache__
.cache
.mypy_cache
.pytest_cache
.ruff_cache
You can also remove additional files/directories if the following options are specified:
- --include-builds:
build directory
dist directory
docs/_build directory: [sphinx]
*.manifest files: [pyinstaller]
*.spec files: [pyinstaller]
- --include-envs:
.venv directory
.nox directory
.tox directory
- --include-metadata:
.eggs directory
*.egg-info directories
.pyre directory
.pytype directory
pip-wheel-metadata directory
- --include-testing:
.coverage file
coverage.xml file
nosetests.xml file
All the above options are specified if you use the --all option.
The following directories are always excluded from the remove:
.git
.hg
.svn
node_modules
Execution example
Clean the current directory except for virtual environments:
cleanpy --all --exclude-envs .
Command help
usage: cleanpy [-h] [-V] [--list] [--follow-symlinks] [--dry-run] [-a] [--include-builds] [--include-envs] [--include-metadata] [--include-testing] [--exclude PATTERN] [--exclude-envs] [-i | -f] [-v |
--debug | --quiet]
DIR_PATH [DIR_PATH ...]
cleanpy will remove cache files and temporary files under the DIR_PATH.
Skip directories from recursive search: .git, .hg, .svn, node_modules
positional arguments:
DIR_PATH path to a root directory to search.
options:
-h, --help show this help message and exit
-V, --version show program's version number and exit
--list print target directories/files. this does not actually remove directories/files.
--follow-symlinks follow symlinks.
--dry-run don't actually do anything.
-i, --interactive prompt on each file/directory delete.
-f, --force delete file/directory without prompt.
-v, --verbose shows the verbose output.
--debug for debug print.
--quiet suppress execution log messages.
Remove Target:
-a, --all remove all of the caches and temporary files.
--include-builds remove files/directories that are related to build: build, dist, docs/_build
--include-envs remove virtual environment caches.
--include-metadata remove metadata.
--include-testing remove test results and coverage files.
--exclude PATTERN a regular expression for files and directories to be excluded from the removes.
--exclude-envs exclude virtual environments from deletion.
Issue tracker: https://github.com/thombashi/cleanpy/issues
Dependencies
Python 3.9+
no external package dependencies
platform independent
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Release history Release notifications | RSS feed
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
File details
Details for the file cleanpy-0.5.1.tar.gz.
File metadata
- Download URL: cleanpy-0.5.1.tar.gz
- Upload date:
- Size: 12.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9ddfa7ce80dd888b597a8b0bfeea3b69567839b6f41b775a4f76f46914d5170e
|
|
| MD5 |
6777186f7978001465e0ae74b4a17a5f
|
|
| BLAKE2b-256 |
da94c10e463f720c804c55cb4b3c5f04380fa03e9b1e2fb7026420528fd89476
|
Provenance
The following attestation bundles were made for cleanpy-0.5.1.tar.gz:
Publisher:
publish.yml on thombashi/cleanpy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cleanpy-0.5.1.tar.gz -
Subject digest:
9ddfa7ce80dd888b597a8b0bfeea3b69567839b6f41b775a4f76f46914d5170e - Sigstore transparency entry: 158184869
- Sigstore integration time:
-
Permalink:
thombashi/cleanpy@60e4a081ccadbbcc1751fff13ce8ee787f73eade -
Branch / Tag:
refs/tags/v0.5.1 - Owner: https://github.com/thombashi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@60e4a081ccadbbcc1751fff13ce8ee787f73eade -
Trigger Event:
push
-
Statement type:
File details
Details for the file cleanpy-0.5.1-py3-none-any.whl.
File metadata
- Download URL: cleanpy-0.5.1-py3-none-any.whl
- Upload date:
- Size: 9.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c60589d5da68527ca0c9151e28ed56fffae69df4ab6c9bfd8c1cf1d9e76a09b8
|
|
| MD5 |
f1367402e17e4ff2e907288de8b98aa0
|
|
| BLAKE2b-256 |
c161cfd606e2425a7490982cdfa5c8da86f35b158eba792f5f9107a1788a2ad7
|
Provenance
The following attestation bundles were made for cleanpy-0.5.1-py3-none-any.whl:
Publisher:
publish.yml on thombashi/cleanpy
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cleanpy-0.5.1-py3-none-any.whl -
Subject digest:
c60589d5da68527ca0c9151e28ed56fffae69df4ab6c9bfd8c1cf1d9e76a09b8 - Sigstore transparency entry: 158184870
- Sigstore integration time:
-
Permalink:
thombashi/cleanpy@60e4a081ccadbbcc1751fff13ce8ee787f73eade -
Branch / Tag:
refs/tags/v0.5.1 - Owner: https://github.com/thombashi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@60e4a081ccadbbcc1751fff13ce8ee787f73eade -
Trigger Event:
push
-
Statement type:
