M122 Automation Project

Overview

This project is part of Module 122: Automating Processes with a Scripting Language.

The goal of this project is to automate the organization of downloaded school files. The application scans a configured folder, extracts module identifiers from filenames (for example M122), categorizes files automatically, and moves them into the correct module folders.

The automation reduces repetitive manual work, improves organization, minimizes mistakes, and demonstrates software engineering concepts such as modular architecture, UML design, logging, error handling, configuration systems, graphical interfaces, and testing.

---

Features

• Automatic file detection
• Filename parsing and module extraction
• Dynamic module-folder mapping
• Configurable subfolder naming
• Automatic folder creation
• Duplicate file handling (_V2, _V3, ...)
• Structured logging system
• Error handling and validation
• Environment variable configuration
• Modular Python architecture
• Configurable project setup
• Graphical User Interface (GUI)
• Progress bar with live status updates
• Custom executable (.exe) support

---

Technologies

• Python 3
• Tkinter GUI
• Filesystem operations
• Python logging module
• Environment variables
• JSON configuration
• Git & GitHub
• python-dotenv
• PyInstaller

---

Project Structure

project-root/
│
├── assets/
│   └── icon.ico
│
├── docs/
│   ├── requirements/
│   ├── design/
│   │   ├── diagrams/
│   │   └── architecture/
│   │
│   └── testing/
│
├── src/
│   ├── main.py
│   ├── gui.py
│   ├── detector.py
│   ├── parser.py
│   ├── logger.py
│   ├── config.py
│   └── mover.py
│
├── config/
│   └── module_mapping.json
│
├── tests/
├── logs/
│
├── input/          (development/testing only)
├── output/         (development/testing only)
│
├── README.md
├── requirements.txt
├── .env.example
├── .gitignore

---

Configuration

The application uses environment variables and JSON configuration.

.env

Example:

DOWNLOADS_PATH=./input
LOG_PATH=./logs
DEFAULT_UNKNOWN_PATH=./output/unknown
MAPPING_FILE=./config/module_mapping.json

---

module_mapping.json

Example:

{
    "modules": {
        "M122":"./output/M122",
        "M123":"./output/M123",
        "M114":"./output/M114"
    },

    "subfolders": {
        "exercise":"Exercises",
        "theory":"Theory",
        "code":"Code"
    }
}

---

Installation

Clone repository

git clone <repository-url>

Navigate into project

cd file-automation-script

Install dependencies

pip install -r requirements.txt

Create environment file

Copy:

.env.example

to:

.env

Adjust the paths if necessary.

---

Usage

Python Version

Run the application:

python src/main.py

---

GUI Version

Run:

python src/gui.py

The GUI provides:

• Start sorting button
• File processing list
• Progress bar
• Status updates
• Error messages
• Sorting summary

---

EXE Version

Build executable:

pyinstaller --onefile --windowed --icon=assets/icon.ico --name="M122 File Organizer" src/gui.py

Executable output:

dist/
└── M122 File Organizer.exe

---

Workflow

1. Scan configured input directory
2. Detect files
3. Extract module identifier
4. Resolve module destination
5. Categorize files automatically
6. Create folders if needed
7. Handle duplicate filenames
8. Move files
9. Write logs
10. Display results

---

Example Output Structure

M122/
├── Exercises/
│   └── LB01.docx
│
├── Theory/
│   └── Notes.pdf
│
├── Code/
│   └── project.py
│
└── random.zip

---

Documentation

Project documentation includes:

• Requirements analysis
• UML activity diagram
• UML component diagram
• Design documentation
• Parsing documentation
• Error handling strategy
• Logging architecture
• Configuration system
• Test protocol

---

Testing

Test cases and testing documentation:

tests/
docs/testing/

---

Author

Nikola

GIBZ Informatik Module 122 – Automating Processes with a Scripting Language