ab-anand / filezen

A cross-platform file organizer that reads your file storing pattern 🗂

1   Filezen

An Intelligent file organizer module which reads your file storing pattern & move the cluttered files accordingly!

Author:	Abhinav Anand

Contents

• 1   Filezen
  • 1.1   What is it
  • 1.2   Features
  • 1.3   Installation
    • 1.3.1   Option 1: installing through pip (Recommended)
    • 1.3.2   Option 2: Installing from source (Only if you must)
  • 1.4   Usage
    • 1.4.1   Simple Scanner
    • 1.4.2   Advanced Scanner
    • 1.4.3   Applications
  • 1.5   Documentation
  • 1.6   Contributing
  • 1.7   Bugs
  • 1.8   License

1.1   What is it

[back to top]

Let's accept, no one likes to organize files on a regular basis. Even if you do, you wouldn't want to do it everytime you download a new file.

Guess what! Filezen got you covered.

Given a folder of your cluttered/unorganized files, using Filezen, you can achieve the following

• If you've never maintained specific directories for your files. Then Filezen's Basic Scanner can create suitable folders and organize your file into them.
• If you already have a pattern of directories for storing different files. Then Filezen's Advanced Scanner can read your file storing pattern and move your files accordingly.

1.2   Features

[back to top]

• Advanced Scanning
• Basic Scanning
• Minimum dependencies ( just uses Pathlib if only you're working with Python 2.x )
• Easy to use
• Fast!
• Returns JSON objects

• Support

  • OS Support: Linux, Windows, Mac
  • Language Support: Python 2.x, 3.x

1.3   Installation

[back to top]

1.3.1   Option 1: installing through pip (Recommended)

pypi package link

$ pip install Filezen

If you are behind a proxy

$ pip --proxy [username:password@]domain_name:port install Filezen

Note: If you get command not found then $ sudo apt-get install python-pip should fix that

1.3.2   Option 2: Installing from source (Only if you must)

$ git clone https://github.com/ab-anand/Filezen.git
$ cd Filezen/
$ pip install -r requirements.txt
$ python setup.py install

Note: If you get permission denied then $ sudo python setup.py install should fix that

1.4   Usage

[back to top]

1.4.1   Simple Scanner

• Simple Scanner uses a predefined mapping of filetypes to folder e.g. ".csv": "Documents".
• Based on this mapping it creates directories(only if they don't exist already) and organizes files into them as shown in the above Fig.
• Using Simple Scanner

>>> from filezen import SimpleScanner as scanner
>>> input_directory = "/home/abhinav/Downloads"
>>> output_directory = "/home/abhinav/Documents"
>>> result = scanner.cleanDirectory(input_directory, outputPath=output_directory)
>>> print(result)
'{
    "Moved": [
        "FileA.pdf",
        "FileB.txt",
        "FileC.mp4",
        "FileD.log",
        "FileB.xyz"
    ],
    "NotMoved": [
    ]
}'

• If no Output Directory is specified, then Simple Scanner would treat Input Directory as the Output Directory thus creating folders in the Input Directory itself.

1.4.2   Advanced Scanner

• Advanced Scanner maintains a heap for each filetype/file-extension it encounters while scanning the Output Directory.
• This heap contains all the directory addresses where a particular filetype(e.g. "pdf") occurs.
• The address having the highest number of occurrence of that filetype is at the top of the heap
• With the help of this heap it finally decides the directory where a particular filetype has mostly occurred and thus moving the all such files into that directory.
• As shown in the above image, Advanced Scanner scans the child as well as sibling directories (at the same level).
• The level of child directories to scan is decided by depth parameter as shown in the example below.
• By default, depth = 5
• Using Advanced Scanner

>>> from filezen import AdvancedScanner as scanner
>>> input_directory = "/home/abhinav/Downloads"
>>> output_directory = "/home/abhinav/Documents"
>>> depth = 3
>>> result = scanner.cleanDirectory(input_directory, outputPath=output_directory, depth=depth)
>>> print(result)
'{
    "Moved": [
        "FileA.pdf",
        "FileB.txt",
        "FileC.mp4",
        "FileD.log",
        "FileE.xyz"
    ],
    "NotMoved": [
    ]
}'

• If no Output Directory is specified, then Advanced Scanner would read the folders in the Input Directory itself and move accordingly.

Note: If a file with the same name is already present in the Output Directory then Filezen would ignore the file and leave it to the user. In the resulting JSON, you'll get the all such filenames which were not moved in the NotMoved list.

1.4.3   Applications

• KRETA - It is a command line application which uses Filezen to organize file.

• Watch Simple Scanner in action with Kreta.
• Watch Advanced Scanner in action with Kreta.

1.5   Documentation

[back to top]

For a detailed usage example, refer the documentation at Read the Docs

1.6   Contributing

[back to top]

Please refer Contributing page for details

1.7   Bugs

[back to top]

Please report the bugs at the issue tracker

1.8   License

[back to top]

Built with ♥ by Abhinav Anand under the MIT License ©

You can find a copy of the License at http://abhinav.mit-license.org/