NotesSpace is a user-friendly web application designed for efficient note-taking. It enables you to input YouTube or file URLs and generates notes for you. The primary code for this application can be found in the NotesSpace folder, while the contents of the test folder were used for project experimentation.
The following are key files responsible for different functionalities of the NotesSpace app:
corpus_grabber.py: This file grabs text from YouTube videos and files and preprocesses them.text_segmentation.py: This file semantically segments the text by topic.app.py: This file contains the Streamlit front end for the app.
To run NotesSpace on your local machine, follow these simple steps:
- Download the repository onto your machine.
- Install the required packages using
pip install -r requirements.txt. - Add a .env file to the root directory of the project and add the following line:
OPENAI_API_KEY=your_openai_api_key. You can get the api key from https://openai.com/api/. - Run
streamlit run NotesSpace/app.pyon your command line. - Enjoy!