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.0.tar.gz (4.6 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.0.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_file_organizer-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8056caed44e7b33e36ca5c06199f88b42a0e824fce7d736fc05e94156201f22e
MD5 8ab915b730426bfdaef65c05a7215dba
BLAKE2b-256 0fafcc485d0f9901639cc29a52dcf6fcf19191344e8e6781e8f5910d56c3337d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_file_organizer-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8de918f6db80ccf1d11b312c1890723e86cd65c0eae59d6fa31025945d734e4d
MD5 8d8b45bfd141b113f83cf69d60f185a0
BLAKE2b-256 e2d63375061bb388f575a5dce18879c6f3231fbb428495dd0085876d802896ea

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