Skip to main content

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

Project description

philiprehberger-file-organizer

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.1.tar.gz (4.7 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.1.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_file_organizer-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b5eaf1546d1f3269dc70935e7614d747ff6e3ee46309d1b25af6e201c9f0a3cc
MD5 b1caeb7755ebb6507d2aa930fa1612a9
BLAKE2b-256 430bb0b0eea2c5dfa02bd658c4122c6a8ddb3aca1777a825c852112f5c1e3f30

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_file_organizer-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 223a4350fb5eeceb3a092f30ebc330aa718f68abfcc93da30f5b05694ce22498
MD5 5835b3fc1390a21e83d9bb5382f9ecd9
BLAKE2b-256 e41c9df83ddf80bf21b1f7bba24d2ad042af204f27a9f4499fb634b25e6d3f31

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