Skip to content

Script to organize notes, exam papers and automatically into categories via a script

License

Notifications You must be signed in to change notification settings

Reymarch995/NB-NotesOrganizer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“š Notesbubble Automatic Study Resource Organizer

Non-commercial use only – This tool is designed to help students and educators automatically organize study resources. Commercial use is prohibited without permission.


πŸš€ Features

  • Automatically sorts study resources into folders based on filename keywords.
  • Sends uncategorized files to an admin review folder.
  • Customizable folder structure and keyword rules.
  • Lightweight and easy to run locally.

βš™οΈ How It Works

  1. Place all study resources in the input folder.
  2. The organizer scans filenames for keywords.
  3. Files are moved into predefined folders based on matches.
  4. Files that don’t match any keywords go to the admin review folder.

πŸ’» Installation

git clone https://github.com/Reymarch995/NB-NotesOrganizer.git
pip install -r requirements.txt
python organizer.py

πŸ›  Configuration

Edit config.json to set:

  • Input folder path
  • Keyword-to-folder mappings
  • Admin review folder path

Example:

{
  "input_folder": "/user-uploads",
  "folders": {
    "Math": ["math", "emath", "mathematics"],
    "Physics": ["physics", "phy"]
  },
  "admin_folder": "/admin_review"
}

πŸ“ Contribution

  • Contributions are welcome for educational and non-commercial purposes only.
  • Submit pull requests or open issues for bug fixes or features.
  • Ensure contributions comply with the NC-SRO license.

πŸ“„ License

This project is licensed under the Non-Commercial Study Resource Organizer License (NC-SRO). See LICENSE.md for full terms.


πŸ“§ Contact

Rayhan, [email protected]

About

Script to organize notes, exam papers and automatically into categories via a script

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published