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

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.3.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.3.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_file_organizer-0.1.3.tar.gz
Algorithm Hash digest
SHA256 e6b6fc192c53268ebdf1eda666afb6d52eb1c6c3e1b51b5d0fcb7402dff977a8
MD5 611a6fe9658c7f5062b85c97f2ae4702
BLAKE2b-256 120fbc33dd829a0bd96c2bdf7de2aa842195506ddbc521392f920ba781c49540

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_file_organizer-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 12297092232bd3ae7f0407fe60bf1985ba2d6ae69cd8515b62b6548346389d1a
MD5 3aa6225e5b2231841659ce96f7b4b446
BLAKE2b-256 5d390c18197444c217b5d6d36fd6a7511e6e70d89a5dc49836a5dd8dc7df8a1c

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