Skip to main content

cleanpy is a CLI tool to remove caches and temporary files that related to Python.

Project description

Summary

cleanpy is a CLI tool to remove caches and temporary files that related to Python.

PyPI package version CI status of Linux/macOS/Windows

Installation

Installation: pip

pip install cleanpy
Supported Python versions Supported Python implementations

Installation: snap

sudo snap install cleanpy
snapcraft status

Usage

cleanpy DIR_PATH [DIR_PATH ...]

cleanpy will remove cache files and temporaly files under the DIR_PATH

Remove files/directories are as follows:

  • files:
    • *.pyc
    • *.pyo
  • directories:
    • __pycache__
    • .cache
    • .mypy_cache
    • .pytest_cache

You can also remove additional files/directories if the following options are specified:

  • --include-builds:
    • build
    • dist
    • docs/_build: [sphinx]
    • *.manifest: [pyinstaller]
    • *.spec: [pyinstaller]
  • --include-envs:
    • .venv
  • --include-metadata:
    • .eggs
    • *.egg-info
    • .pyre/
    • .pytype/
    • pip-wheel-metadata
  • --include-testing:
    • .nox
    • .tox
    • .coverage
    • coverage.xml
    • nosetests.xml

All of the above options are specified if set the --all option to the command.

Following directories are excluded from the search:

  • .git
  • .hg
  • .svn
  • node_modules

Execution example

$ cleanpy -avf --exclude-envs .
[INFO] remove directory [cache - Python]: ./test/__pycache__
[INFO] remove directory [cache - pytest]: ./.pytest_cache
[INFO] remove directory [testing - manager]: ./.tox
[INFO] remove directory [build - Python]: ./dist
[INFO] remove directory [cache - mypy]: ./.mypy_cache
[INFO] remove directory [metadata - type checker]: ./.pytype
[INFO] remove directory [build - Python]: ./build
[INFO] remove directory [metadata - Python]: ./cleanpy.egg-info
[INFO] removed 8 directories

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 ...]

Remove cache files and temporary files that related to Python.

Skip directories from recursive search: .git, .hg, .svn, node_modules

positional arguments:
  DIR_PATH            path to a root directory to search.

optional arguments:
  -h, --help          show this help message and exit
  -V, --version       show program's version number and exit
  --list              print target directories/files. does not actually remove.
  --follow-symlinks   follow symlinks.
  --dry-run           do no harm.
  -i, --interactive   prompt before remove.
  -f, --force         no prompt before remove.
  -v, --verbose       shows verbose output.
  --debug             for debug print.
  --quiet             suppress execution log messages.

Remove Target:
  -a, --all           remove all of the caches and teporary files.
  --include-builds    remove files/directories that related build: build, dist, docs/_build
  --include-envs      remove virtual environments.
  --include-metadata  remove metadata.
  --include-testing   remove test results and coverage files.
  --exclude PATTERN   a regular expression that matches files and directories that should be excluded on recursive searches.
  --exclude-envs      exclude virtual environments.

Issue tracker: https://github.com/thombashi/cleanpy/issues

Dependencies

Python 3.6+

  • no external package dependencies
  • platform independent

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cleanpy-0.3.1.tar.gz (11.4 kB view hashes)

Uploaded source

Built Distribution

cleanpy-0.3.1-py3-none-any.whl (9.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page