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.5.tar.gz (5.0 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.5.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_file_organizer-0.1.5.tar.gz
Algorithm Hash digest
SHA256 702b224e010a56d38335fa33eaa74ab6f21ca51a0b111d5d2281f3edff0d256d
MD5 fbce622d9547576f840eb6aa52f40673
BLAKE2b-256 2bb888e60f958a4aaa46e5c9d6d1ea50a45bc21e7defaa6322cffc42f95e645c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_file_organizer-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 389692ddf022c0bfa1e6217e5c89833144c3bd733e2ea4aaf57328472595b9ab
MD5 717109d856a2c4270f84867ab20d2fc2
BLAKE2b-256 892e771de3b7d9252335e4ad3927adecfe4fa02c2f0a35fb6bcc240dbf73c516

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