py-trashguard

Author: avishek devnath (avishekdevnath@gmail.com)
License: MIT License

A safe, user-friendly alternative to os.remove() that moves files to a .trash/ folder instead of deleting them permanently. Use it as a Python API or a CLI tool to protect your files from accidental deletion.

Features

• Soft-delete files: Move files to a .trash/ directory instead of permanent removal
• Restore files: Bring back files from the trash easily
• List trashed files: See what’s in your trash
• No dependencies: 100% Python standard library

Installation

Install from PyPI:

pip install py-trashguard

Or install from source:

pip install .

Usage

Python API Example

from pytrashguard import trash, restore, list_trash

# Move a file to trash
t = trash("myfile.txt")
print(f"Trashed: {t}")

# List trashed files
print("In trash:", list_trash())

# Restore a file from trash
r = restore("myfile.txt")
print(f"Restored: {r}")

Command Line Interface Example

Move a file to trash:

py-trashguard --trash myfile.txt

List trashed files:

py-trashguard --list

Restore a file from trash:

py-trashguard --restore myfile.txt

Project Structure

• pytrashguard/core.py: Core logic
• pytrashguard/cli.py: CLI entry point
• pytrashguard/__init__.py: API exposure
• pyproject.toml: Packaging
• README.md: Documentation
• LICENSE: MIT License

License

This project is licensed under the MIT License. See the LICENSE file for details.