Skip to main content

a high level api for handling recycle bins across platforms

Project description

pytrash

a high level api for handling recycle bins across platforms

Installation

uv add pytrash

Usage

import pytrash

# pytrash provides a way to move files to the bin, list entries in bin, and restore files from bin.
# create instance of Bin
bin = pytrash.RecycleBin()

# move a file to the bin
bin.recycle(["path/to/file.txt"])

# list entries
bin.entries()

# restore a file from the bin
entry = bin.entries()[0]
bin.restore([entry])

# permanently delete a file from the bin (irreversible!)
bin.purge([entry])

# permanently delete everything in the bin (irreversible!)
bin.empty()

That's it. It doesn't get any simpler than that.

Entries are returned as a list of TrashEntry dataclasses, which contain the following attributes:

TrashEntry(
  name='Screenshot from 2026-06-10 17-35-55.png',
  original_path='/home/nspc911/Pictures/Screenshots/Screenshot from 2026-06-10 17-35-55.png',  # this will be None if entry doesn't contain this info
  deleted_at=datetime.datetime(2026, 6, 28, 11, 31, 17),  # this can be None if entry doesn't contain this info
  size=13075  # shouldn't be None, but it is possible.
)

For now, only the major 3 OSes are supported (Windows, Linux, MacOS). If you want to add support for your OS, feel free to open a PR.

CLI

This also includes a CLI for interacting with the recycle bin

uv tool install pytrash
pytrash trash <file1> <file2> ...  # move files to the bin
pytrash list                       # list entries in the bin
pytrash list --json                # list entries in the bin
pytrash restore <entry1> <entry2> ...  # restore entries from the bin
pytrash purge <entry1> <entry2> ...    # permanently delete entries (asks first; -y to skip)
pytrash empty                          # permanently delete everything (asks first; -y to skip)

This CLI interface is not to be compared with the trashy CLI, it is Rust, it doesn't have the Python Interpreter overhead. This project aims to provide an easy interface for cross platform bins. The CLI is simply a way to make use of it.

Like what I do? Check out similar projects

  • multiarchive: a high level api for handling archives across formats

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

pytrash-0.3.1.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

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

pytrash-0.3.1-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

Details for the file pytrash-0.3.1.tar.gz.

File metadata

  • Download URL: pytrash-0.3.1.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for pytrash-0.3.1.tar.gz
Algorithm Hash digest
SHA256 c86e4af32af077648624cc54363fa4f8fc9646117d0513c9345173aa60d6b8dd
MD5 f9607666eb64b1755a36c15264edfd44
BLAKE2b-256 8b9b41fa97f7b4e2cb23627282b70bec10376cdf0e6c337b6ac31cdbd22a2e82

See more details on using hashes here.

File details

Details for the file pytrash-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: pytrash-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 20.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for pytrash-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b2716d5890d19eb63e490d53a408f0d31b34bc1545e8e743f214134545d41f97
MD5 f0d95f6b465ad40e1fc84ffdf5a1f219
BLAKE2b-256 2e544f1a0eb886507428f1d938d92dc47b355f23c369ea13c2fbc7dfac21fb59

See more details on using hashes here.

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