File Organizer

A program that organise a directory or path.
Video Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Packages
2. Getting Started
   • Prerequisites
3. Usage
   • Installation
4. Run Tests
5. Contributors
6. Contributing
7. Show Your Support
8. Contact
9. Acknowledgments

About The Project:

File Organizer is a program that organize files into folders on your computer. These files are arranged based on the file extension, and also, allows you to move the created folders to a specific directory you want. These helps to keep track of all your files.

Key Features:

• Helps users organise files.

• Helps keep the directory or path clean and well kept.

• Helps users keep track of where a particular file is.

Built With:

• Python3.10.7

Packages:

You can find all the packages and their version used, in the requirements.txt file

back to top

Getting Started:

Download:

You can download the source code to run the script from the command line on Windows, macOS and Linux. This will require Python.

Prerequisites:

1. Install Python

   From Python official website: Python

back to top

Usage:

Installation:

1. Clone the repo

   git clone https://github.com/Deerah1234/File-Organizer.git

2. Change Directory (cd) into where the files are located

   • Windows, MacOs, Linux

     cd project_directory

3. Create a Virtual Environment and Activate it

   • Windows

     • Create venv

     python -m venv my_venv

     • Activate my_venv

     .\my_venv\Scripts\activate

   • MacOs, Linux

     • Create venv

     python3 -m venv my_env

     • Activate venv

     source my_venv/bin/activate

4. Download all the packages from the requirements.txt file

   • Windows, MacOs, Linux

     pip install -r requirements.txt

     Note: Make sure you have python installed

5. Run the following command in the project folder

   • MacOs, Linux

     python3 project.py

     Windows

     py main.py

6. Follow the prompts and see how the program work

back to top

Run Tests:

1. Make sure you are on the repository directory/ project directory

   • Run

     pytest -s test.py

     Note: Make sure you have activated the venv

2. Follow the prompt to test

back to top

Contributors:

• @Nqabenhle

back to top

Contributing:

• Fork the repo
• Add your changes
• Commit your changes
• Push your changes to the repo
• Open an issue or pull request
• Submit a pull request to the master branch or the appropriate branch
• I will be happy to review your pull request

back to top

Show Your Support:

Give a ⭐ if you like this project!.

back to top

Contact:

Github: @Deerah1234

LinkedIn: @EmmanuelJames

Twitter: @0xDeerah

back to top

Acknowledgments:

I want to thank GOD for making this project a success.

back to top

License:

This project is MIT licensed.

back to top

@cyiomDev - 2022