Metadata-Version: 2.1
Name: command-line-file-manager
Version: 1.1.6
Summary: CLI tool for managing local file system storage
Author-email: Kaloyan Ivanov <kaloyan.ivanov88@gmail.com>
License: MIT License
        
        Copyright (c) 2022 Kaloyan Ivanov
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click==8.1.7
Requires-Dist: emoji==2.8.0
Requires-Dist: directory-tree==0.0.4
Provides-Extra: dev
Requires-Dist: tox==4.11.3; extra == "dev"
Requires-Dist: codespell==2.2.6; extra == "dev"
Requires-Dist: black==23.9.1; extra == "dev"
Requires-Dist: pytest==7.4.2; extra == "dev"
Requires-Dist: build==1.0.3; extra == "dev"
Requires-Dist: twine==5.1.1; extra == "dev"

# command-line-file-manager

[![PyPI](https://img.shields.io/pypi/v/command-line-file-manager.svg)](https://pypi.org/project/command-line-file-manager/)
[![Downloads](https://static.pepy.tech/badge/command-line-file-manager)](https://pepy.tech/project/command-line-file-manager)

Python CLI tool for scanning and organizing local directories and files.

#### Requires Python 3.10+

## Installation


Via pip:
```console
$ pip install command-line-file-manager
```

From main branch:
```console
$ git clone https://github.com/kaliv0/command-line-file-manager.git
$ cd command-line-file-manager 
$ pip install .
```

## Example


To run the application type <i>fm</i> followed by a sub-command, target directory and options
```console
$ fm scan-files ../test --sort=type --save --output=./
```

Add --help after the <i>fm</i> command or any of the subcommands to get more information
```console
$ fm scan-files --help

Usage: fm scan-files [OPTIONS] DIR_PATH

  DIR_PATH: Path to directory to be scanned

Options:
  --sort [name|size|date|modified|type]   Sorting criteria.  [default: name]
  --desc                                  Display result in descending order.
  -s, --save                              Save log message to file.
  -o, --output TEXT                       Path to output directory for the saved log file.
  --help                                  Show this message and exit.
```
