Metadata-Version: 2.3
Name: simple-file-org
Version: 0.1.0
Summary: Organize files into folders based on creation times
Requires-Python: >=3.12
Requires-Dist: pydate>=1.2.0
Requires-Dist: pytz>=2024.1
Requires-Dist: typer>=0.12.3
Description-Content-Type: text/markdown

# simple-file-org

A very simple tool to organize files into folders based on creation times.

## Usage

```bash
simple-file-org --help

Usage: simple-file-org [OPTIONS] SOURCE TARGET

Organizes files in the specified folder by year and date.
Args:     source (Path): The folder path where the files will be read from.     target (Path): The folder path where the files will be moved to.
Returns:     None

╭─ Arguments ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *    source      DIRECTORY  The source directory where the files will be read from. [default: None] [required]                                                                                                                                                                                                                                                         │
│ *    target      DIRECTORY  The target directory where the files will be moved to. [default: None] [required]                                                                                                                                                                                                                                                          │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                                                                                                                                                                                                                                                                                            │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

## Installation

```bash
pip install simplefile-org
```

## Development

If you want to develop on this project, you can use the following instructions to setup your development environment.

### Requirements

- `rye 0.40.0+`

### Setup

```bash
rye sync
```

### Unit Tests

```bash
rye run unit
```
