frenamer 0.0.1

Rename and unrename all files in the directory, alphabetically or randomly

Frenamer (file-renamer)

Rename and unrename all files in the directory, alphabetically or randomly

Table of Contents

1. Requirements
2. Installation
   • With PyPi
   • With GitHub
   • Update
3. Usage
   • Help message
   • Rename
     • Help message
     • Alphabetically
     • Randomly
   • Unrename
     • Help message
4. Discussions
5. Issues
6. License

Requirements

• Python >= 3.8

Installation

PyPi

$ pip3 install frenamer

GitHub

$ git clone https://github.com/TheAwiteb/frenamer/
$ cd frenamer
$ sudo python3 setup.py install

Update

$ python3 -m pip install frenamer --upgrade

Usage

Help message

Usage: python3 -m frenamer [OPTIONS] COMMAND [ARGS]...

    Frenamer (File-Renamer) Tool help you to rename files and directories
    alphabetical or random names.

Options:
    -V, --version  Frenamer (File-Renamer) version.
    -h, --help         Show this message and exit.

Commands:
    rename    rename directories.
    unrename  unrename directories.

Rename

Help message

Usage: python3 -m frenamer rename [OPTIONS] DIRECTORIES...

  rename directories.

Arguments:
  DIRECTORIES...  Directories whose contents you want to rename.  [required]

Options:
  -r, --random                Rename with random names, or alphabetically.
                              [default: False]

  -l, --length INTEGER        Random name length.  [default: 10]
  -s, --save-date             Save directory names before and after renaming.
                              [default: False]

  -f, --filename TEXT         The name of the json file in which the directory
                              names are to be saved.  [default:
                              rename_data.json]

  -h, --help                      Show this message and exit.

Alphabetically

$ python3 -m frenamer rename <my_directory>
$ python3 -m frenamer rename --save-date  <my_directory>
$ python3 -m frenamer rename --save-date --filename data.json <my_directory>

Randomly

$ python3 -m frenamer rename --random <my_directory>
$ python3 -m frenamer rename --random --length 15  <my_directory>

Unrename

Help message

Usage: python3 -m frenamer unrename [OPTIONS] DIRECTORIES...

  unrename directories.

Arguments:
  DIRECTORIES...  Directories whose contents you want to unrename.  [required]

Options:
  -d, --delete         Delete the JSON files that were used in the unrenaming
                       after completion.  [default: False]

  -f, --filename TEXT  The name of the json file from which the directory
                       names will be extracted.  [default: rename_data.json]


  -h, --help                      Show this message and exit.

$ python3 -m frenamer unrename <my_directory>
$ python3 -m frenamer unrename --filename data.json <my_directory>
$ python3 -m frenamer unrename --delete <my_directory>

Discussions

Question, feature request, discuss about frenamer here

Issues

You can report a bug here

License

The MIT License (MIT). Please see License File for more information.