renamer-cli 1.2.2

A command-line tool for fast and flexible file and directory renaming.

Renamer-CLI

Renamer-CLI is a simple command-line tool designed to streamline file management tasks, particularly for data scientists and developers. With customizable naming patterns and intuitive features, Renamer-CLI empowers users to effortlessly organize and rename files, saving time and enhancing productivity across various projects and workflows.

Table of Contents

• Installation
• Usage
• Patterns
  • Name and Extension
  • Parent Directory
  • Date
  • More Soon...
• Options
  • File Only
  • Directory Only
  • Extension
  • Interactive
  • Recursive
  • Undo
• Contributing
• License

Installation

Renamer-CLI requires Python 3 and pip to be installed on your system. You can install Renamer-CLI using pip:

pip install renamer-cli

Usage

Renamer-CLI offers a variety of powerful features to streamline your file management tasks.

usage: renamer [-h] [-d DIRECTORY] [-p PATTERN] [-f] [-D] [-e EXTENSIONS [EXTENSIONS ...]] [-r] [-i] [-u]

Rename files and directories based on a user-defined pattern

options:
  -h, --help            show this help message and exit
  -d DIRECTORY, --directory DIRECTORY
                        Path to the directory containing files and directories to be renamed.
  -p PATTERN, --pattern PATTERN
                        Naming pattern for renaming files and directories. Use placeholders like {name}, {parent}, {date}, etc.
  -f, --files-only      Rename only files, not directories.
  -D, --directories-only
                        Rename only directories, not files.
  -e EXTENSIONS [EXTENSIONS ...], --extensions EXTENSIONS [EXTENSIONS ...]
                        Rename only files with specified extensions.
  -r, --recursive       Perform renaming recursively, including files and directories in subdirectories.
  -i, --interactive     Enable interactive mode for manual confirmation of each renaming operation.
  -u, --undo            Undo the last file and directory renaming operation.

Patterns

Name and Extension

Renamer-CLI allows you to customize filenames by incorporating both name and extension.

Parent Directory

Easily include the parent directory name in your filenames for better organization.

Date

Automatically add date information to your filenames for versioning or sorting.

More Soon...

Stay tuned for additional pattern options coming soon!

Options

All these options can be combined to tailor the renaming process to your specific needs.

File Only

Effortlessly filter and rename files only, leaving directories untouched.

Directory Only

Similarly, focus exclusively on directories, perfect for organizing your file structure.

Extension

Refine your renaming process by filtering files based on specific extensions.

Interactive

Engage with an interactive mode to confirm each renaming operation.

Recursive

Enable recursive mode to apply renaming operations to all subdirectories.

Undo

Effortlessly revert the last renaming operation with the undo feature.

Contributing

Thank you for considering contributing to renamer-cli! Contributions are welcome from everyone.

How to Contribute

If you'd like to contribute to renamer-cli, please follow these steps:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them to your branch.
4. Push your changes to your fork.
5. Submit a pull request to the main repository.

Code Style

Please adhere to the project's code style and conventions.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository.

License

This project is licensed under the MIT License.