Project Goal(s) • Contributors • Installation & Usage • How to Contribute? • Compiling Into Executable
- This is a small program that automatically moves and sorts files from chosen source to destination. It uses PySimpleGUI to create a minimal GUI for the user.
- Anyone is welcome to work on it and add whatever features they wish, as long as they adhere to the Code of Conduct and the Contributing Guidelines.
- This project is especially interesting for Python beginners who don't have a project idea, but would like to work on something or anyone participating in the annual Hacktoberfest and looking to contribute to a project.
This project aims to create a small, user-friendly tool to help people with organizing their files through use of simple algorithms that provide a number of sorting options.
Specifically, this project looks to provide the user with:
- A program that automatically moves/copies and sorts files from user-designated source to destination directory
- A user-friendly interface for managing files
- The option to automatically move/copy and sort files from removable devices
- The option to automatically sort directories or partitions as content is added, changed or removed
First, clone this repository:
# Clone the repository
$ git clone https://github.com/Kreateer/automatic-file-sorterMake sure you have Python 3.8+ installed on your system:
# Install Python 3.8
$ sudo apt-get install python3.8You may also need to install the tkinter module for Python:
# Install tkinter for Python 3
$ sudo apt-get python3-tkNext, install the dependencies:
# Install dependencies
$ pip3 install -r requirements.txtFinally, locate fmain.py and run the script through an IDE or through console:
# cd to where 'fmain.py' is located
$ cd <clonelocation>/automatic-file-sorter/scripts
# run 'fmain.py'
$ sudo python3 fmain.pyOnce you run the program, just follow the GUI instructions.
Make sure you have Python 3.8+ installed. If you don't, you can download the Windows release from the official Python site.
Once Python is installed, you need to install the dependencies using pip.
IMPORTANT: If you're using an IDE like PyCharm, preferably you can use the IDE options to install packages in a virtual environment
In Command Prompt, type:
pip install -r requirements.txtThen simply launch fmain.py through an IDE or through Command Prompt:
#cd to where 'fmain.py' is located
cd <clonelocation>/automatic-file-sorter/scripts
#run 'fmain.py'
python fmain.pyOnce you run the program, just follow the GUI instructions.
This is the 'hall of fame' for all the wonderful people who contributed to this project. It's a way to say a huge 'Thank You' to all contributors for helping out!
Every contribution, no matter how small or large, is welcome and equally important! ❤️❤️
 Matija Milaković 📆🤔💻 📖 |
 Pushp Vashisht 💻 |
 Arjun K 💻 |
 Saptarsi Saha 💻 |
 Joseph Wang 💻 |
 polynoman 💻 |
- First, refer to the Contributing Guidelines
- Take a look at the existing Issues or create your own Issues to work on!
- Wait for the Issue to be assigned to you before you start working on it.
- Fork the repository and create a Branch for any Issue that you are working on.
- Create a Pull Request which will be promptly reviewed and suggestions might be added to improve it.
- Optional, but it would be helpful if you added screenshots to help everyone know how your fix or new feature works.
Otherwise, if you are new to GitHub or have never contributed to GH projects, you can refer to these helpful guides on how to contribute:
- If you wish to build the source yourself and run the program from an executable instead of running the script everytime, you can use PyInstaller to compile the script into an
.exefile.