README.md

Program: File organiser

Description: A Python script used to organise files, especially in the "Downloads" folder

• Programmer: ammaar0x01
• Started: 14.04.24
• Updated: 12.12.24
• Status: COMPLETED

---

Introduction

• This is a simple Python script used to organise files in a folder
• Run the script in a folder (directory) that you want to organise

---

Project structure

Py_File_organiser/
|── controlled_env/                
│   ├── (random files...)
└── .gitignore 
└── Organise.py
└── README.md               

---

Pre-requisites

• Python installed

---

Download

• Download the zipped folder
• Use the following git command git clone https://github.com/ammaar0x01/Py_file_organiser.git

---

Run the program

Testing the script

1. Navigate to the "controlled_env" directory
2. Open your terminal
3. Run the python script py Organise.py
4. The files should be organised in specific folders

Organise your files

1. Navigate to the folder that you want to organise
2. Copy and paste "Organise.py" to that folder
3. Run the python script py Organise.py

---

Contribution guidelines

1. Fork the repository

2. Create a new feature branch

git branch <branch name>
git checkout -b feature-name

3. Commit your changes

git commit -m "Add new feature"

4. Push your branch

git push origin feature-name

5. Open a pull request

---