Metadata-Version: 2.1
Name: dircleaner
Version: 0.1.0
Summary: CLI utility to sort directories based on file extensions
Project-URL: Homepage, https://github.com/griquelme/dircleaner
Author: Gabriel Riquelme
License: BSD 3-Clause License
        
        Copyright (c) 2023, Gabriel Riquelme. All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.9
Requires-Dist: click>8.1
Description-Content-Type: text/markdown

cleandir
========

Organizes a directory's contents into subdirectories based on file extensions.

Say goodbye to navigating between hundreds of files in your downloads directory!


Installation
------------

```shell
pip install cleandir
```

Usage
-----

Just pass the directory to organize as an argument

```shell
cleandir <dir-name>
```

By default, cleandir organizes files using the following rules:

* audio:      flac, mp3, ogg, wav
* documents:  docx, pdf, pptx, xlsx
* misc:       7z, deb, exe, rar, zip
* pictures:   gif, jpg, png, svg, webp
* videos:     mkv, mov, mp4, webm

Extensions outside this rule are ignored

Custom rules can be passed by creating a JSON file directories and list of extensions:

```json
{
  "audio": ["mp3", "wav"],
  "code": ["py", "c", "js"],
}
```

```shell
cleandir --json-file <json-file> <dir-name>
```

If duplicates files exists in the created directory, they can be removed by using the `--delete-duplicates` flag:

```shell
cleandir -d <dir-name>
```

Available help can be seen through the `--help` flag:

```shell
cleandir --help
```