Skip to main content

CLI tool to organize and rename files.

Project description

batch-work: A Tool to Organize and Rename File

Introduction

This is a command-line utility tool written in Python that helps you organize and rename files in a directory. It sorts files into different folders based on their file extensions and renames files with a specified prefix.

Features

  1. File sorting: The script sorts files into the following categories:

    • Image files (.jpg, .png, .gif, etc.)
    • Audio files (.mp3, .wav, .flac, etc.)
    • Video files (.mp4, .avi, .mov, etc.)
    • Document files (.pdf, .doc, .txt, etc.)
    • Other files
  2. File renaming: The script renames files in a directory with a specified prefix and sequential numbers.

Usage

  1. File sorting:
    bw_sort <directory_path>
    

Replace <directory_path> with the path to the directory containing the files you want to sort. Recommended to cd to the directory that contains the folder you want to sort.

  1. File renaming:
    bw_rename <prefix> <directory_path>
    

Replace with the desired prefix for the files and <directory_path> with the path to the directory containing the files you want to rename. Recommended to cd to the directory that contains the folder whose contents you want to rename.

Installation

Recommended method: Install the latest version:

```bash
pip install batch-work
```

Or install from Github:

```bash
pip install https://github.com/UgyenNorbu/batch-work/releases/download/v0.1.1/batch_work-0.1.2.tar.gz
```

Dependencies

Package tree is required. Install the latest version:

```bash
pip install tree
```

Contributing

We appreciate your interest in contributing to the batch-work project. Your contributions can help improve this tool for everyone. Here's how you can get involved:

Reporting Issues

If you encounter any bugs or have suggestions for improvements:

  1. Check the existing issues to see if it has already been reported.
  2. If not, open a new issue, providing as much detail as possible:
    • Steps to reproduce the bug
    • Expected vs. actual behavior
    • Your environment (OS, Python version, etc.)
    • Any relevant screenshots or error messages

Submitting Changes

To contribute code or documentation:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/YourFeatureName)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add some feature')
  5. Push to your branch (git push origin feature/YourFeatureName)
  6. Open a Pull Request against the main branch

Questions or Suggestions

For general questions or suggestions about the batch-work project, please open a new discussion in our GitHub Discussions area.

License

This project is licensed under the MIT License - see the LICENSE file for details.

TODO

  • Add functions to delete empty folders
  • Find dublicate files and delete

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

batch_work-0.2.0.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

batch_work-0.2.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file batch_work-0.2.0.tar.gz.

File metadata

  • Download URL: batch_work-0.2.0.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for batch_work-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c9b894af0be473db530b66c8a32fac5d1faa20e98225b81dd097c6279b7e6638
MD5 e8dc920660bccd25cf550736d8268014
BLAKE2b-256 cb7df5dc5a3127110382436fef069594187789fb600312361309d8c8dda013f6

See more details on using hashes here.

File details

Details for the file batch_work-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: batch_work-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for batch_work-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb9b8bac99044015c489e30822a707cec5454d38d8de567f0815ad9f9bf633bf
MD5 74dc704f5b95fea7272d8ad68057d710
BLAKE2b-256 1a0c74f7928fb54c2d6c4bcd5fa826067bbf622ca5658a15e9f912150f6c8a54

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page