/python-renamer

Primary LanguagePython

README

SETUP

install python3 command on your machine

make setup

Suggested: activate the virtualenv

source .env/vin/activate

RUN RENAMER:

python renamer.py <options> <directory> <matcher> <replace_string>

to run it directly chmod +x renamer.py:

./renamer.py <directory> <matcher> <replace_string>

where parameters are:

  • options:
    • d: dry_run, no renaming
    • q: quiet, no logging
    • c: clean, no journal (WARN: no rollback available with no journal)
    • r: regexp_match, evaluates the matcher as a regexp on the whole file, allows group indicators in replace_string (i.e.: $1, $2, etc.)
  • directory: root directory containing files to rename
    • warn: the script works recursively on subdirectories
  • matcher: regexp matching the part of a filename to replace
  • replace_string: string to use for replacement

example (generates only journal):

python renamer.py dq test '\.jpeg' '.jpg'

RUN RENAMER:

python prepender.py <options> <directory> <matcher> <prefix>

to run it directly chmod +x renamer.py:

./prepender.py <directory> <matcher> <prefix>

where parameters are:

  • options:
    • d: dry_run, no renaming
    • q: quiet, no logging
    • c: clean, no journal (WARN: no rollback available with no journal)
  • directory: root directory containing files to rename
    • warn: the script works recursively on subdirectories
  • matcher: regexp matching the part of a filename to replace
  • prefix: string to use as a prefix

example (generates only journal):

python renamer.py dq test '\.jpeg' '.jpg'

RUN ROLLBACK:

python rollback.py <options> <journal_file>

to run it directly chmod +x rollback.py:

./rollback.py <options> <journal_file>

where parameters are:

  • options:
    • d: dry_run, no renaming
    • q: quiet, no logging
  • journal_file: journal file to rollback

example (log only actions):

python rename_rollback.py d test/rename-journal_test_1677664708.yaml