Skip to content

arcivanov/pypi-cleanup

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
.github/workflows
.github/workflows
 
 
src
src
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
build.py
build.py
 
 
pyproject.toml
pyproject.toml
 
 
setup.py
setup.py
 
 

Repository files navigation

PyPI Bulk Release Version Cleanup Utility

PyPI Cleanup Version PyPI Cleanup Python Versions Build Status PyPI Cleanup Downloads Per Day PyPI Cleanup Downloads Per Week PyPI Cleanup Downloads Per Month

Overview

PyPI Bulk Release Version Cleanup Utility (pypi-cleanup) is designed to bulk-delete releases from PyPI that match specified patterns. This utility is most useful when CI/CD method produces a swarm of temporary .devN pre-releases in between versioned releases.

Being able to cleanup past .devN junk helps PyPI cut down on the storage requirements and keeps release history neatly organized.

WARNING

THIS UTILITY IS DESTRUCTIVE AND CAN POTENTIALLY WRECK YOUR PROJECT RELEASES AND MAKE THE PROJECT INACCESSIBLE ON PYPI.

This utility is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.

Details

The default package release version selection pattern is r".*dev\d+$".

Authentication password may be passed via environment variable PYPI_CLEANUP_PASSWORD. Otherwise, you will be prompted to enter it.

Authentication with TOTP is supported.

Examples:

$ pypi-cleanup --help
usage: pypi-cleanup [-h] [-u USERNAME] -p PACKAGES [-t URL] [-r PATTERNS | --leave-most-recent-only] [--query-only] [--do-it] [--delete-project] [-y] [-d DAYS] [-v]

PyPi Package Cleanup Utility v0.1.8

options:
  -h, --help            show this help message and exit
  -u USERNAME, --username USERNAME
                        authentication username (default: None)
  -p PACKAGES, --package PACKAGES
                        PyPI package name (default: None)
  -t URL, --host URL    PyPI <proto>://<host> prefix (default: https://pypi.org/)
  -r PATTERNS, --version-regex PATTERNS
                        regex to use to match package versions to be deleted (default: None)
  --leave-most-recent-only
                        delete all releases except the *most recent* one, i.e. the one containing the most recently created files (default: False)
  --query-only          only queries and processes the package, no login required (default: False)
  --do-it               actually perform the destructive delete (default: False)
  --delete-project      actually perform the destructive delete that will remove all versions of the project (default: False)
  -y, --yes             confirm extremely dangerous destructive delete (default: False)
  -d DAYS, --days DAYS  only delete releases **matching specified patterns** where all files are older than X days (default: 0)
  -v, --verbose         be verbose (default: 0)

Query-Only Mode

Query-only mode is a safe mode that simply displays all package versions matches and exits, without requiring authentication or removing safeties:

$ pypi-cleanup -p karellen-llvm-core -p karellen-llvm-clang -r '.*rc\d.*' --query-only
INFO:root:Running in QUERY-ONLY mode
INFO:root:Will use the following patterns [re.compile('.*rc\\d.*')] on package 'karellen-llvm-core'
INFO:root:Found the following releases of package 'karellen-llvm-core' to delete:
INFO:root: 19.1.0.0rc1.post62
INFO:root: 19.1.0.0rc2
INFO:root: 19.1.0.0rc2.post43
INFO:root: 19.1.0.0rc2.post45
INFO:root: 19.1.0.0rc2.post52
INFO:root: 19.1.0.0rc2.post59
INFO:root: 19.1.0.0rc2.post69
INFO:root: 19.1.0.0rc3
INFO:root: 19.1.0.0rc3.post12
INFO:root: 19.1.0.0rc3.post50
INFO:root: 19.1.0.0rc3.post53
INFO:root: 19.1.0.0rc4
INFO:root: 19.1.0.0rc4.post6
INFO:root: 19.1.0.0rc4.post13
INFO:root: 19.1.0.0rc4.post18
INFO:root:Query-only mode - exiting

Regular Cleanup of Development Artifacts

First without the --do-it confirmation, i.e. in DRY RUN mode, including authentication and getting as close as possible to deleting without actually doing it:

$ pypi-cleanup -u arcivanov -p pybuilder
INFO:root:Running in DRY RUN mode
INFO:root:Will use the following patterns [re.compile('.*\\.dev\\d+$')] on package 'pybuilder'
INFO:root:Found the following releases of package 'pybuilder' to delete:
INFO:root: 0.13.13.dev20240604074936
INFO:root: 0.13.14.dev20240814015648
Password: 
Authentication code: 933344
INFO:root:Would be deleting 'pybuilder' version 0.13.13.dev20240604074936, but not doing it!
INFO:root:Would be deleting 'pybuilder' version 0.13.14.dev20240814015648, but not doing it!

Now to actually delete the specificed packages

$ pypi-cleanup -u arcivanov -p pybuilder --do-it
WARNING:root:!!! POSSIBLE DESTRUCTIVE OPERATION !!!
INFO:root:Will use the following patterns [re.compile('.*\\.dev\\d+$')] on package 'pybuilder'
INFO:root:Found the following releases of package 'pybuilder' to delete:
INFO:root: 0.13.13.dev20240604074936
INFO:root: 0.13.14.dev20240814015648
Password: 
Authentication code: 123456
WARNING:root:!!! WILL ACTUALLY DELETE THINGS - LAST CHANCE TO CHANGE YOUR MIND !!!
WARNING:root:Sleeping for 5 seconds - Ctrl-C to abort!
INFO:root:Deleting 'pybuilder' version 0.13.13.dev20240604074936
INFO:root:Deleted 'pybuilder' version 0.13.13.dev20240604074936
INFO:root:Deleting 'pybuilder' version 0.13.14.dev20240814015648
INFO:root:Deleted 'pybuilder' version 0.13.14.dev20240814015648

Using Custom Regex Pattern

$ pypi-cleanup -u arcivanov -p geventmp -r '.*\\.dev1$'
WARNING:root:
WARNING:
        You're using custom patterns: [re.compile('.*\\\\.dev1$')].
        If you make a mistake in your patterns you can potentially wipe critical versions irrecoverably.
        Make sure to test your patterns before running the destructive cleanup.
        Once you're satisfied the patterns are correct re-run with `-y`/`--yes` to confirm you know what you're doing.
        Goodbye.
$ pypi-cleanup -u arcivanov -p geventmp -r '.*\\.dev1$' -y
Password:
WARNING:root:RUNNING IN DRY-RUN MODE
INFO:root:Will use the following patterns [re.compile('.*\\.dev1$')] on package geventmp
Authentication code: 123456
INFO:root:Deleting geventmp version 0.0.1.dev1

Deleting All Versions Except The Most Recent One

List all versions that are going to be deleted except for the most recent one:

$ pypi-cleanup -p pypi-cleanup --leave-most-recent-only --query-only
INFO:root:Running in QUERY-ONLY mode
INFO:root:Will only leave the MOST RECENT version of the package 'pypi-cleanup'
INFO:root:Leaving the MOST RECENT version for 'pypi-cleanup': 0.1.7 - 2024-06-25T05:53:47.930884+0000
INFO:root:Found the following releases of package 'pypi-cleanup' to delete:
INFO:root: 0.0.1
INFO:root: 0.0.2
INFO:root: 0.0.3
INFO:root: 0.1.0
INFO:root: 0.1.1
INFO:root: 0.1.2
INFO:root: 0.1.3
INFO:root: 0.1.4
INFO:root: 0.1.5
INFO:root: 0.1.6
INFO:root:Query-only mode - exiting

Proceeding with deletion of everything except the most recent version requires pulling safeties:

$ pypi-cleanup -p pypi-cleanup --leave-most-recent-only
WARNING:root:
WARNING:
        You're trying to delete ALL versions of the package EXCEPT for the *most recent one*, i.e.
        the one with the most recent (by the wall clock) files, disregarding the actual version numbers
        or versioning schemes!

        You can potentially wipe critical versions irrecoverably.
        Make sure this is what you really want before running the destructive cleanup.
        Once you're sure you want to delete all versions except the most recent one,
        re-run with `-y`/`--yes` to confirm you know what you're doing.
        Goodbye.

Deleting Multiple Packages

Specify multiple packages by adding additional -p arguments as follows:

$ pypi-cleanup -p karellen-llvm-core -p karellen-llvm-clang -p karellen-llvm-lldb -p karellen-llvm-toolchain-tools -r '.*rc\d.*' -y -u karellen --do-it
WARNING:root:!!! POSSIBLE DESTRUCTIVE OPERATION !!!
INFO:root:Will use the following patterns [re.compile('.*rc\\d.*')] on package 'karellen-llvm-core'
INFO:root:Will use the following patterns [re.compile('.*rc\\d.*')] on package 'karellen-llvm-clang'
INFO:root:Will use the following patterns [re.compile('.*rc\\d.*')] on package 'karellen-llvm-lldb'
INFO:root:Will use the following patterns [re.compile('.*rc\\d.*')] on package 'karellen-llvm-toolchain-tools'
INFO:root:Found the following releases of package 'karellen-llvm-core' to delete:
INFO:root: 19.1.0.0rc1.post62
INFO:root: 19.1.0.0rc2
INFO:root: 19.1.0.0rc2.post43
INFO:root: 19.1.0.0rc2.post45
INFO:root: 19.1.0.0rc2.post52
INFO:root: 19.1.0.0rc2.post59
INFO:root: 19.1.0.0rc2.post69
INFO:root: 19.1.0.0rc3
INFO:root: 19.1.0.0rc3.post12
INFO:root: 19.1.0.0rc3.post50
INFO:root: 19.1.0.0rc3.post53
INFO:root: 19.1.0.0rc4
INFO:root: 19.1.0.0rc4.post6
INFO:root: 19.1.0.0rc4.post13
INFO:root: 19.1.0.0rc4.post18
INFO:root:Found the following releases of package 'karellen-llvm-clang' to delete:
INFO:root: 19.1.0.0rc1.post62
INFO:root: 19.1.0.0rc2
INFO:root: 19.1.0.0rc2.post43
INFO:root: 19.1.0.0rc2.post45
INFO:root: 19.1.0.0rc2.post52
INFO:root: 19.1.0.0rc2.post59
INFO:root: 19.1.0.0rc2.post69
INFO:root: 19.1.0.0rc3
INFO:root: 19.1.0.0rc3.post12
INFO:root: 19.1.0.0rc3.post50
INFO:root: 19.1.0.0rc3.post53
INFO:root: 19.1.0.0rc4
INFO:root: 19.1.0.0rc4.post6
INFO:root: 19.1.0.0rc4.post13
INFO:root: 19.1.0.0rc4.post18
INFO:root:Found the following releases of package 'karellen-llvm-lldb' to delete:
INFO:root: 19.1.0.0rc4.post6
INFO:root: 19.1.0.0rc4.post13
INFO:root: 19.1.0.0rc4.post18
INFO:root:Found the following releases of package 'karellen-llvm-toolchain-tools' to delete:
INFO:root: 19.1.0.0rc1.post62
INFO:root: 19.1.0.0rc2
INFO:root: 19.1.0.0rc2.post43
INFO:root: 19.1.0.0rc2.post45
INFO:root: 19.1.0.0rc2.post52
INFO:root: 19.1.0.0rc2.post59
INFO:root: 19.1.0.0rc2.post69
INFO:root: 19.1.0.0rc3
INFO:root: 19.1.0.0rc3.post12
INFO:root: 19.1.0.0rc3.post50
INFO:root: 19.1.0.0rc3.post53
INFO:root: 19.1.0.0rc4
INFO:root: 19.1.0.0rc4.post6
INFO:root: 19.1.0.0rc4.post13
INFO:root: 19.1.0.0rc4.post18
Password: 
Authentication code: 123456
WARNING:root:!!! WILL ACTUALLY DELETE THINGS - LAST CHANCE TO CHANGE YOUR MIND !!!
WARNING:root:Sleeping for 5 seconds - Ctrl-C to abort!
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc1.post62
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc1.post62
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc2
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc2
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc2.post43
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc2.post43
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc2.post45
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc2.post45
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc2.post52
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc2.post52
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc2.post59
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc2.post59
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc2.post69
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc2.post69
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc3
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc3
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc3.post12
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc3.post12
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc3.post50
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc3.post50
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc3.post53
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc3.post53
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc4
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc4
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc4.post6
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc4.post6
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc4.post13
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc4.post13
INFO:root:Deleting 'karellen-llvm-core' version 19.1.0.0rc4.post18
INFO:root:Deleted 'karellen-llvm-core' version 19.1.0.0rc4.post18
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc1.post62
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc1.post62
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc2
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc2
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc2.post43
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc2.post43
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc2.post45
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc2.post45
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc2.post52
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc2.post52
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc2.post59
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc2.post59
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc2.post69
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc2.post69
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc3
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc3
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc3.post12
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc3.post12
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc3.post50
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc3.post50
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc3.post53
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc3.post53
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc4
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc4
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc4.post6
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc4.post6
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc4.post13
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc4.post13
INFO:root:Deleting 'karellen-llvm-clang' version 19.1.0.0rc4.post18
INFO:root:Deleted 'karellen-llvm-clang' version 19.1.0.0rc4.post18
INFO:root:Deleting 'karellen-llvm-lldb' version 19.1.0.0rc4.post6
INFO:root:Deleted 'karellen-llvm-lldb' version 19.1.0.0rc4.post6
INFO:root:Deleting 'karellen-llvm-lldb' version 19.1.0.0rc4.post13
INFO:root:Deleted 'karellen-llvm-lldb' version 19.1.0.0rc4.post13
INFO:root:Deleting 'karellen-llvm-lldb' version 19.1.0.0rc4.post18
INFO:root:Deleted 'karellen-llvm-lldb' version 19.1.0.0rc4.post18
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc1.post62
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc1.post62
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2.post43
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2.post43
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2.post45
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2.post45
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2.post52
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2.post52
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2.post59
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2.post59
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2.post69
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc2.post69
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc3
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc3
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc3.post12
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc3.post12
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc3.post50
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc3.post50
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc3.post53
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc3.post53
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc4
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc4
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc4.post6
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc4.post6
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc4.post13
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc4.post13
INFO:root:Deleting 'karellen-llvm-toolchain-tools' version 19.1.0.0rc4.post18
INFO:root:Deleted 'karellen-llvm-toolchain-tools' version 19.1.0.0rc4.post18

About

PyPI Bulk Release Version Cleanup Utility

Resources

Readme

License

Apache-2.0 license
Activity

Stars

20 stars

Watchers

2 watching

Forks

9 forks
Report repository

Releases 7

Release v0.1.8 Latest
Sep 20, 2024
+ 6 releases

Packages

No packages published

Contributors 5

Languages