Skip to content
This repository has been archived by the owner on Sep 17, 2020. It is now read-only.

omushpapa/sorter

Sorter

Latest Release Issues Travis-CI Codacy Badge

Sorter makes file organisation easier. It simply helps you organise several files that contain similar characteristics into a single folder. You can put all letter documents into one folder, all images with the word home into another, all music by one artist in yet another folder, etc.

Sorter organises these files into folders which are grouped according to one or more of the following patterns:

  • A common name in multiple files' names. For example, multiple files may have a common word(s) season one. Every file bearing these word(s) will be moved to (by default) a folder named season one.
  • A custom name (of your choosing). For example, after searching using the above criteria, you might choose the destination folder to be named My Series.
  • By file type/format. For instance, pdf files will be put in a folder named PDF, docx files in a DOCX folder, jpeg files in a JPEG folder, etc.
  • By categories of the file formats. For instance, pdf, docx and txt files are all documents, hence will be put in a folder named document. These categories are defined in filegroups

Sorter majorly focuses on file management but most of these operations should generally apply to folders too.

Note: If you want a folder and its contents to be left as is (i.e. not to be sorted or affected in any way), just add a file named .signore (no extension) into the folder.

Download

Visit Sorter for features, download and usage tutorials.

Recommended: See the full list of supported OSes at Sorter - Official Releases

Clone

Prerequisites

NB: View the requirements for detailed requirements

Open terminal

Do

git clone https://github.com/giantas/sorter.git`

cd sorter

python sorter.py

Compile executable DIY

Install Prerequisites

NB: View the requirements for detailed requirements

How to compile

  • Create and activate a Virtual Environment (optional but recommended)
  • Ensure prerequisites are available
  • Clone this repository
  • In terminal/cmd, run the command in pybuild.sh
  • Check into the dist/ and copy the sorter folder to any location for use.

In terminal:

pip install --user pipenv
git clone https://github.com/giantas/sorter.git
cd sorter
pipenv sync
bash pybuild.sh
mkdir ~/apps/
cp -R dist/sorter ~/apps
cd ~/apps/sorter
./sorter

Website

Contributing

Thank you for your interest in contributing to the Sorter project. To get you started, have a look at the contribution guidelines

Authors

License

  • This project is licensed under the BSD 3-clause "New" or "Revised" License - see the LICENSE file for details

TODO

Suggest new Feature

  • Add support for customised file grouping

Warning

The coverage results exclude the GUI code. I will not write test for the GUI classes as most of the operations are separate.