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.1.3.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

batch_work-0.1.3-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: batch_work-0.1.3.tar.gz
  • Upload date:
  • Size: 4.4 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.1.3.tar.gz
Algorithm Hash digest
SHA256 591a6748d2e8fd43218dcc3ab5c029f73a93a0edbea1669d9dee38afaec9a9f3
MD5 259acf6b422dba13c862e26ff284c873
BLAKE2b-256 90ab460a2976d5c2a8b2097693a5890bb49bd039a824ea1fef95e1fe276f5049

See more details on using hashes here.

File details

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

File metadata

  • Download URL: batch_work-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 5.6 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.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c4b56ad35e2ea6bee8de684858a07357c0bd6f1b2a087a54642ebd74ab25c4f7
MD5 bc3bb45ee7519ea49c72310761e7e941
BLAKE2b-256 0792454121892a3c9252939115716a160f32dbf9814c9a10bcf0f5514494067d

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