Metadata-Version: 2.1
Name: classifier-reborn
Version: 3.0.4
Summary: Classify the files in your Downloads folder into suitable destinations
Home-page: https://github.com/iwishiwasaneagle/classifier/
Author: Bhrigu Srivastava
Author-email: captain.bhrigu@gmail.com
Maintainer: Jan-Hendrik Ewers
Maintainer-email: dev.jh.ewers@gmail.com
License: MIT
Project-URL: Tracker, https://github.com/iwishiwasaneagle/classifier/issues
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Provides-Extra: test


# Classifier

[![CI](https://github.com/iwishiwasaneagle/classifier/actions/workflows/CI.yml/badge.svg)](https://github.com/iwishiwasaneagle/classifier/actions/workflows/CI.yml)
[![codecov](https://codecov.io/gh/iwishiwasaneagle/classifier/branch/master/graph/badge.svg?token=ZW51EYKLL0)](https://codecov.io/gh/iwishiwasaneagle/classifier)
[![PyPI version](https://badge.fury.io/py/classifier-reborn.svg)](https://badge.fury.io/py/classifier-reborn)
[![GitHub](https://img.shields.io/github/license/iwishiwasaneagle/classifier)](https://github.com/iwishiwasaneagle/classifier/blob/master/LICENSE)


Organize files in your current directory, by classifying them into folders of music, pdfs, images, etc.

## Installation

```sh
$ pip install classifier-reborn
```

#### Compatibility
* Python 3.7 - Python 3.9
* Linux / OSX / Windows


## Usage
* Go to your directory, where you want to classify your files.
* Run the following command in your terminal.
```sh
$ classifier
```
```sh
>> Scanning Files
>> Done!
```

## Example
### Before:
```
Downloads
│   ├── project.docx
│   ├── 21 Guns.mp3
│   ├── Sultans of Swing.mp3
│   ├── report.pdf
│   ├── charts.pdf
│   ├── VacationPic.png
│   ├── CKEditor.zip
│   ├── Cats.jpg
│   └── archive.7z
```

### After:
```
Downloads
│   ├── Music
│   │   ├── 21 Guns.mp3
│   │   └── Sultans of Swing.mp3
|   |
│   ├── Documents
│   │   ├── project.docx
│   │   ├── report.pdf
│   │   └── charts.pdf
|   |
│   ├── Archives
│   │   ├── CKEditor.zip
│   │   └── archive.7z
|   |
│   ├── Pictures
│   │   ├── VacationPic.png
│   │   └── Cats.jpg
```


## Options
`classifier [-dt] [-st SPECIFIC_TYPES [SPECIFIC_TYPES ...]] [-sf SPECIFIC_FOLDER] [-o OUTPUT]`

optional arguments:

	-h --help				show help message and exit
	
	-dt --date				Classify the files by their Creation Date
	-st --specific-types			Move the specific file extensions into the Specific Folder
	-sf --specific-folder			Folder to move files with Specific Type
	
	-d --directory				The directory whose files you want to classify
	-o --output				Main directory to put organized folders
	
	-v --version         			show version
	-t --types           			Show the current list of types and formats
	-et --edittypes      			Edit the list of types and formats (edit the CONFIG)
	
	-rst					Reset the CONFIG file


### Example
###### Classify specific file types
`classifier -st py pyc -sf "Python Files"`

### Before
```
Workspace
│   ├── views.py
│   ├── temp.pyc
│   ├── game.java
│   ├── index.html
│   └── script.py
```


### After
```
Workspace
│   ├── Python Files
│   │   ├── views.py
│   │   ├── temp.pyc
|   |	└── script.py
|   |
|   ├── game.java
|   └── index.html

```

### Example
###### Classify by Date:
`classifier -dt`

### Example
###### Classify files of directory '/home/source' and put them in location '/home/dest':
`classifier -d /home/source -o /home/dest`

`Note: ` If -d (source directory) is given without -o (output) directory, this will classify the files of source directory Eg:<br>
`classifier -d /home/source'`<br>
This classifies the directory /home/source.



### View the CONFIG, how files will be sorted
`classifier -t`

### Edit the CONFIG, to set up manual settings for classification
`classifier -et`

### Reset the CONFIG file
`classifier -rst`
```

```

======

## The MIT License
> Copyright (c) 2015 Bhrigu Srivastava http://bhrigu123.github.io

> 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.
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.


