About

A video player designed to assist visually impaired developers who want to learn to code. The program reads code from videos to assist visually impaired developers in using these resources.

Features - (need more info) TODO

[Demo Video here]

• Ability to upload, or enter a video link.
• OcrRoo picks out any code text from the provided video, and reads that text to the user.

Installation

To install and run this project, please follow the Installation Guide in the Wiki.

Basic Installation

1. Navigate to the projects root folder

   cd dip-programming-prj-advanced-gui-architect/

2. Create a virtual environment

   Windows

   python -m venv ./venv # create virtual environment
   ./venv/Scripts/activate # activate virtual

   Linux / Mac OS X

   python3 -m venv./venv # create virtual environment
   source venv/bin/activate # activate virtual

3. Activate the virtual environment Windows:

   ./venv/Scripts/activate

   Mac/Linux

   source venv/bin/activate

4. Install dependencies with pip

   pip install -r requirements.txt

5. Run the Application

To run the application with silenced debug/logging output, execute the following command. Debug and logging outputs will be saved to an app.log file

   python app/app.py

Additional Configuration

1. This project requires the Tesseract OCR Library (note: may require an installer).

   Tesseract OCR Documentation: https://tesseract-ocr.github.io/tessdoc/Installation.html

   Windows Installer: https://github.com/UB-Mannheim/tesseract/wiki

   WARNING: Tesseract should be either installed in the directory which is suggested during the installation or in a new directory. The uninstaller removes the whole installation directory. If you installed Tesseract in an existing directory, that directory will be removed with all its subdirectories and files.

2. The project currently requires an API Key for OpenAI.

   OpenAI API: https://openai.com/index/openai-api/

3. This project requires the PATH to your IDE executable.

Update the above configuration variables into the below file:

   app/config.ini

Running the Project

1. Once the Installation and Configuration steps have been completed; navigate and run:

   python app/app.py

To run the application with debug/logging output in the console, use the following command.This is recommended for development as it automatically reloads the app when changes are detected.

   flask run --debug

2. The terminal will display the localhost link for the project in the console.

Contributing

To contribute to this project, please follow the Contribution Guide in the Wiki.

Code of Conduct

• To view the code of conduct, please visit the [Code of Conduct] page in the Wiki.

License

This project is licensed under the Creative Commons Zero v1.0 Universal license.

Credits

This code was first created by the 2023, S2 Advanced Programming Diploma Group at North Metro TAFE. If you would like your contribution acknowledged, please contact Rafael.