Metadata-Version: 2.4
Name: kps-file-organizer
Version: 0.2.0
Summary: A powerful and configurable command-line tool to organize your files effortlessly.
Author-email: Krishna Pratap Singh <kps369@proton.me>
Project-URL: Homepage, https://github.com/kps369/file-organizer
Project-URL: Bug Tracker, https://github.com/kps369/file-organizer/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer
Requires-Dist: rich
Dynamic: license-file

# File Organizer CLI

A powerful and configurable command-line tool to organize your files effortlessly.

## Overview

This tool helps you keep your directories tidy by moving files into dedicated folders based on their extension, creation date, or custom rules you define.

## Features

*   Organize files by their extension (e.g., `.pdf`, `.jpg`, `.docx`).
*   Sort files into folders by creation date (e.g., `YYYY-MM-DD`).
*   Highly configurable using a `config.yaml` file.
*   Cross-platform and easy to use.

## Installation

You can install the File Organizer CLI directly from PyPI:

```bash
pip install kps-file-organizer
```

## Usage

Here are a couple of examples of how to use the tool.

### Organize by File Extension

This command will scan the specified directory and group files into subdirectories based on their extension (e.g., `pdf`, `jpg`, `txt`).

```bash
file-organizer /path/to/your/directory --by-extension
```

### Organize by Date

This command will scan the specified directory and group files into subdirectories based on their modification date.

```bash
file-organizer /path/to/your/directory --by-date
```

## Author

- **Krishna Pratap Singh**
- GitHub: [kps369](https://github.com/kps369)

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
