The Notes Logger App is a Python application for logging and organizing your notes. It utilizes KeyBERT to identify the most important words in your notes, which are then highlighted using rich text formatting.
- Add new notes and assign them a category for easy organization
- Automatically identify and highlight important words in your notes using KeyBERT
- View all of your notes in a color-coded, easy-to-read table
- Clone the repository:
git clone https://github.com/AndreasKaratzas/notes-logger.git
- Create a conda virtual environment and install the required Python packages:
conda env create --file environment.yml
conda activate notes-logger
- To use
manim
, follow these instructions with respect to your OS.
First, create your new note under the data/notes
directory. You can use any name you want, but you have to preserve the .json
format demonstrated in the dummyNote.json
sample file:
{
"Date": "<day>-<month>-<year>",
"Short Description": "Short description of the note",
"Link to powerpoint": "Link to some presentation in case you have one",
"Expected project length": "<x> mon + <y> days"
}
Then, start the application and compile your notes into a table by running:
python main.py
There are additional arguments you can use. Type python main.py --help
to see them.
- Fix the issue with whitespace before ')' and ']' and '}' and '>' and ending '`' in short description column.
- Fix the issue with whitespace removal between some words in short description column.
- Add
CODE_OF_CONDUCT.md
The Notes Logger App was developed by Andreas Karatzas. It utilizes the following Python packages:
- KeyBERT
- Rich
This application is released under the GNU Affero General Public License v3.0. See the LICENSE
file for more information.
- Fork the repository.
- Make your changes and commit them.
- Submit a pull request.
If you have any questions or concerns, please contact me at [email protected].