renamer-kt 1.0.2

Description:

renamerkt 1.0.2

Renamer

CLI tool written in Python 3 used to systemically rename files in a directory while adhering to a variety of criteria.


This program attempts to emulate the simplicity of the CLI program FFmpeg but for renaming files. Basic operations are straight-forward, while complex operations only invovle adding more flags and parameters to your operation. A directory with files that contain some numerical pattern are all that's required to get started. The application is well-paired for other software that require strict naming schemes, such as Plex, Kodi, or image managers.

Installation

Install renamer-kt using pip:
bash
pip install renamer-kt

Make sure you have Python and pip installed.
Usage



Operation
Flag
Flag(Formal)
Parameter(s)
Example
Description




Shift
-s
--shift
Number Shift (int)
--shift -1
Shifts all numerical values by the specified offset


Zeroes
-z
--zeroes
Leading Zeroes [int]
-z 3
Prepends numerical values with the specified or inferred number of leading zeroes


Format
-f
--fmt
Output Format (str)
-f "Episode $d"
Customizes filename output (see wiki for usage)


Extension
-e
--ext
File Extension (str)
--ext png
Changes the extension of all files to the specified extension


Random
-n
--random
Random Seed [int]
-n 839693
Shuffles numerical values using the specified seed, or randomly


Consecutive
-c
--consecutive


Flattens numerical values such that they are all consecutive


Mute
-m
--mute


Squelches the console output of filenames and their renamed filename


Confirm
-y
--yes


Confirms the operation and makes changes to your file system according to the parameters


Version
-v
--version


Prints the version number of the program


Help
-h
--help


Prints the help text for the program



Usage Examples
The following usage snippets use this directory as a template:
mydir/
2021vacation0001.jpeg
2021vacation0003.jpeg
2021vacation0004.jpeg
2021vacation0010.jpeg

Clean-up

e.g. 1.jpeg, 3.jpeg, 4.jpeg, 10.jpeg

renamer mydir

Formalize & Fix Ordering

01.jpeg, 02.jpeg, 03.jpeg, 04.jpeg

renamer mydir -z 1 -c

Format & Modify Extension

2021 Vacation - 1.png, 2021 Vacation - 3.png, 2021 Vacation - 4.png, 2021 Vacation - 10.png

renamer mydir -e png -f "2021 Vacation - $d"

Shift & Flatten

4.jpeg, 5.jpeg, 6.jpeg, 7.jpeg

renamer mydir -s 3 -c

Meta
Kevin Tyrrell – [email protected]
Distributed under the GPL3 license. See LICENSE for more information.
https://github.com/KevinTyrrell
Contributing

Fork it (https://github.com/KevinTyrrell/Renamer)
Create your feature branch (git checkout -b feature/fooBar)
Commit your changes (git commit -am 'Add some fooBar')
Push to the branch (git push origin feature/fooBar)
Create a new Pull Request