readme_content = """
An intelligent, offline-first file organizer built with Python + SentenceTransformers. It automatically predicts appropriate folder names for your files based on filename and content, organizes them into labeled directories, and improves over time through learning.
🧠 It learns from you — so you only have to review unrecognized files once. Future runs are automatic.
- ✅ Offline AI classification (no internet needed)
- 📂 Organizes files by predicting folders (Education, Finance, ID, etc.)
- 🔍 Scans PDFs and filenames for better accuracy
- 🧠 Learns from your corrections and saves them
- 🧑🏫 Optional: give it training data or guide it during the first run
- Python 3.8+
- Install dependencies: pip install -r requirements.txt
Dependencies:
- sentence-transformers
- scikit-learn
- PyMuPDF
-
Loads training examples from:
- labels.json (your saved knowledge)
- training_labels.json (pre-seeded examples)
- User-defined labels (optional prompt at start)
-
Scans a directory (default: ~/Desktop/TestFiles)
-
Predicts folder/category for each file based on name + content
-
Moves files into:
- Organized//
- Or Organized/Uncategorized/ if unsure
-
Asks if you'd like to review the uncategorized files to help it learn
After organizing:
Organized/ ├── Education/ │ └── UOW Transcript.pdf ├── Finance/ │ └── bank_statement.pdf ├── Health/ │ └── Medibank Policy.pdf ├── Uncategorized/ │ └── unknown_file.pdf
Edit training_labels.json to preload examples and categories.
{ "examples": [ "University transcript", "Medibank insurance card", "Visa approval grant letter" ], "labels": [ "Education", "Health", "Immigration" ] }
At the bottom of main.py:
target = "~/TestFiles"
Change it to wherever you want to scan files from.
- Decluttering your Downloads/ folder
- Organizing scanned documents
- Sorting personal PDFs, bank records, IDs, etc.
MIT License © 2025
Built with ❤️ by Soham Verma
"""
` readme_path = "/mnt/data/README.md" with open(readme_path, "w") as f: f.write(readme_content)
readme_path `