Skip to main content

Rule-based file sorting engine with pattern matching and dry run support

Project description

philiprehberger-file-organizer

Tests PyPI version License

Rule-based file sorting engine with pattern matching and dry run support.

Install

pip install philiprehberger-file-organizer

Usage

from philiprehberger_file_organizer import Organizer, Rule

organizer = Organizer(
    rules=[
        Rule(extensions=[".pdf", ".doc", ".docx"], destination="~/Documents"),
        Rule(extensions=[".jpg", ".png", ".gif"], destination="~/Pictures"),
        Rule(extensions=[".mp4", ".mkv"], destination="~/Videos"),
        Rule(pattern="invoice_*", destination="~/Documents/Invoices"),
    ]
)

# Preview what would happen (dry run)
report = organizer.preview("~/Downloads")
for action in report.actions:
    print(f"{action.source} -> {action.destination}")

# Execute
report = organizer.organize("~/Downloads")
print(f"Moved {report.total_moved} files ({report.total_size} bytes)")

# Undo
restored = Organizer.undo("~/Downloads")

Rule Options

Option Description
extensions Match by file extension
pattern Match by glob pattern
name_contains Match if filename contains string
larger_than Minimum file size in bytes
smaller_than Maximum file size in bytes
older_than_days Match files older than N days
newer_than_days Match files newer than N days
predicate Custom matching function

Conflict Resolution

organizer = Organizer(rules=rules, conflict="rename")   # default: adds (1), (2)...
organizer = Organizer(rules=rules, conflict="skip")      # skip existing
organizer = Organizer(rules=rules, conflict="overwrite")  # overwrite existing

Development

pip install -e .
python -m pytest tests/ -v

License

MIT

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

philiprehberger_file_organizer-0.1.4.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file philiprehberger_file_organizer-0.1.4.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_file_organizer-0.1.4.tar.gz
Algorithm Hash digest
SHA256 5e391599f194b06d7724c5ecebba8e239e3efc24ba5c98c518880fe323f0d136
MD5 0a2ed472c01a7aff6118158752effcf4
BLAKE2b-256 9a7afd4ae48fe8723bac975d38d58fc3aa76f78e86aa436ed74383475926d5dc

See more details on using hashes here.

File details

Details for the file philiprehberger_file_organizer-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_file_organizer-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 aec41c44f4109eb402f3d4223148d8dc561aba0055a94fa19b787bdd155d87c9
MD5 3b2b9efdc2579d683478f2ea23a28fe5
BLAKE2b-256 2a5267053ecb15c49222090f2a51c27bea7419fa9854b50f2cf0e17810b58efd

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