Automatic Documentation Generation for Class Lectures — An AI-powered slide-to-markdown file converter.
- Run the following command:
pip install -r requirements.txt
- Make a service account for a GCloud project. You will get a
jsonfile as a key for the account. Set the environment variableGOOGLE_APPLICATION_CREDENTIALSto the path to that key. Here's how you do that on the command line:
export GOOGLE_APPLICATION_CREDENTIALS='path/to/access/creds.json'
- Get an OpenAI API key. This should be a string. Set the environment variable
OPENAI_API_KEYto that string. Here's how you do that on the command line:
export OPENAI_API_KEY="some_string_api"
- Run the conversion process through
runner.py. The process will create atmpfolder to host your temporary files, and create a markdown file with the same name as the input file.
python3 runner.py [filename]
More instructions about how to run the program can be found through
python3 runner.py --help
If you want your tmp to be auto-deleted after the run, use the --clean-up flag.
This project is a work-in-progress. In all honesty, it does not work very well. I would not recommend anyone use this for production or commercial purposes.