From a612e55ad3f5aeeddd2199d05950aedda4714138 Mon Sep 17 00:00:00 2001 From: Rumsie-Grimshaw Date: Sun, 26 May 2024 20:42:37 +0800 Subject: [PATCH 1/8] Added installation and setup/config instructions to README.md. Fixes #2 --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 47 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ce9c228..d7cd0c7 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ 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) +## Features - (need more info) TODO --- @@ -43,30 +43,62 @@ in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-me 2. Create a virtual environment -```bash -python -m venv ./venv -``` + ```bash + python -m venv ./venv + ``` 3. Activate the virtual environment Windows: -```bash -./venv/Scripts/activate -``` + ```bash + ./venv/Scripts/activate + ``` -Mac/Linux + Mac/Linux -```bash -source venv/bin/activate -``` + ```bash + source venv/bin/activate + ``` 4. Install dependencies with pip -```bash -pip install -r requirements.txt -``` + ```bash + pip install -r requirements.txt + ``` -5. ...rest of installation steps here +5. 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. + + See: [AppSettings] in config.ini + +## Configuration / Initial SetUp + +1. The project requires a personal ChatGPT API Key. + + OpenAI API: https://openai.com/index/openai-api/ + + See: [AppSettings] in config.ini + +2. The project requires the path to your IDE executable: + + See: [AppSettings] in config.ini + + +## Running the Project: + +1. Once the Installation and Configuration/SetUp steps have been completed; navigate and run: + ```bash + app.py + ``` + +2. Once running, the terminal will display the localhost link for the project in the console. ## Contributing From 06487a8e1f6eb68a2420d088926d312ad6f62a52 Mon Sep 17 00:00:00 2001 From: Rumsie-Grimshaw Date: Sun, 26 May 2024 20:50:47 +0800 Subject: [PATCH 2/8] Added more specific file information in the Configuration/SetUp sections of the README.md Fixes #2 --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d7cd0c7..a89e63a 100644 --- a/README.md +++ b/README.md @@ -76,26 +76,24 @@ in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-me 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. - See: [AppSettings] in config.ini + See: [AppSettings] in app/config.ini ## Configuration / Initial SetUp 1. The project requires a personal ChatGPT API Key. OpenAI API: https://openai.com/index/openai-api/ - - See: [AppSettings] in config.ini + See: [AppSettings] in app/config.ini 2. The project requires the path to your IDE executable: - - See: [AppSettings] in config.ini + See: [AppSettings] in app/config.ini -## Running the Project: +## Running the Project 1. Once the Installation and Configuration/SetUp steps have been completed; navigate and run: ```bash - app.py + app/app.py ``` 2. Once running, the terminal will display the localhost link for the project in the console. From d67d84285cc2250a8a610ea8a3c73ffcc60ea4eb Mon Sep 17 00:00:00 2001 From: Rumsie-Grimshaw Date: Sun, 26 May 2024 20:55:20 +0800 Subject: [PATCH 3/8] Corrected formatting issues from previous commit. Fixes #2 --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a89e63a..5c867f1 100644 --- a/README.md +++ b/README.md @@ -76,17 +76,17 @@ in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-me 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. - See: [AppSettings] in app/config.ini + Refer to: [AppSettings] in app/config.ini ## Configuration / Initial SetUp 1. The project requires a personal ChatGPT API Key. - OpenAI API: https://openai.com/index/openai-api/ - See: [AppSettings] in app/config.ini + OpenAI API: https://openai.com/index/openai-api/ + Refer to:[AppSettings] in app/config.ini -2. The project requires the path to your IDE executable: - See: [AppSettings] in app/config.ini +2. The project requires the path to your IDE executable: + Refer to: [AppSettings] in app/config.ini ## Running the Project From 59b88436c18b7b10070e7c8af640e21f81ebd897 Mon Sep 17 00:00:00 2001 From: Rumsie-Grimshaw Date: Sun, 26 May 2024 20:56:47 +0800 Subject: [PATCH 4/8] Final formatting fixes applied to README.md Fixes #2 --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c867f1..2116b93 100644 --- a/README.md +++ b/README.md @@ -83,9 +83,11 @@ in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-me 1. The project requires a personal ChatGPT API Key. OpenAI API: https://openai.com/index/openai-api/ - Refer to:[AppSettings] in app/config.ini + + Refer to: [AppSettings] in app/config.ini 2. The project requires the path to your IDE executable: + Refer to: [AppSettings] in app/config.ini From ecf3d3857e3a39d63195634b9d59836692266eca Mon Sep 17 00:00:00 2001 From: Rumsie-Grimshaw Date: Wed, 29 May 2024 19:37:08 +0800 Subject: [PATCH 5/8] Added more specific information to README.md to align with the installation page. --- README.md | 67 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 47 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 2116b93..1c366fd 100644 --- a/README.md +++ b/README.md @@ -34,17 +34,31 @@ The program reads code from videos to assist visually impaired developers in usi ## Installation -To install and run this project, please follow the [Installation Guide](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/wiki/Installation-Guide) -in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/wiki). +To install and run this project, please follow the [Installation Guide](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki/Installation-Guide) +in the [Wiki](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki). #### Basic Installation 1. Navigate to the projects root folder + ```bash + cd dip-programming-prj-advanced-gui-architect/ + ``` + 2. Create a virtual environment + Windows + + ```bash + python -m venv ./venv # create virtual environment + ./venv/Scripts/activate # activate virtual + ``` + + Linux / Mac OS X + ```bash - python -m venv ./venv + python3 -m venv./venv # create virtual environment + source venv/bin/activate # activate virtual ``` 3. Activate the virtual environment @@ -65,8 +79,18 @@ in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-me ```bash pip install -r requirements.txt ``` + +5. Run the Application -5. This project requires the Tesseract OCR Library (note: may require an installer). +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 + + ```bash + 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 @@ -76,40 +100,43 @@ in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-me 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. - Refer to: [AppSettings] in app/config.ini - -## Configuration / Initial SetUp +2. The project currently requires an API Key for OpenAI. -1. The project requires a personal ChatGPT API Key. + OpenAI API: https://openai.com/index/openai-api/ - OpenAI API: https://openai.com/index/openai-api/ - - Refer to: [AppSettings] in app/config.ini +3. This project requires the PATH to your IDE executable. -2. The project requires the path to your IDE executable: - - Refer to: [AppSettings] in app/config.ini +Update the above configuration variables into the below file: + ```bash + config.ini + ``` ## Running the Project -1. Once the Installation and Configuration/SetUp steps have been completed; navigate and run: +1. Once the Installation and Configuration steps have been completed; navigate and run: + ```bash + 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. + ```bash - app/app.py + flask run --debug ``` -2. Once running, the terminal will display the localhost link for the project in the console. +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](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/wiki/Contribution-Guide) -in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/wiki). +To contribute to this project, please follow the [Contribution Guide](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki/Contributor's-Guide) +in the [Wiki](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki). ## Code of Conduct --- -- To view the code of conduct, please visit the [Code of Conduct] page in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/wiki). +- To view the code of conduct, please visit the [Code of Conduct] page in the [Wiki](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki). ## License From b395880bc7b80cd9129f5d4b51aad438e409ef08 Mon Sep 17 00:00:00 2001 From: Rumsie-Grimshaw Date: Wed, 29 May 2024 19:39:55 +0800 Subject: [PATCH 6/8] Updated badge links to correctly link to team Architects build/accessability and test pages. Fixes #2 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1c366fd..f3dfa5a 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,9 @@ **AI Powered OCR Code Recognition from Video Tutorials** -[![Build](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/build.yml/badge.svg)](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/build.yml) -[![Tests](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/tests.yml/badge.svg)](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/tests.yml) -[![Accessibility](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/accesibility.yml/badge.svg)](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/accesibility.yml) +[![Build](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/build.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/build.yml) +[![Tests](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/tests.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/tests.yml) +[![Accessibility](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/accesibility.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/accesibility.yml) From 4cd6c6d1ad3da751b0d7f6b4473c950474f9205e Mon Sep 17 00:00:00 2001 From: Rumsie-Grimshaw Date: Wed, 29 May 2024 19:55:01 +0800 Subject: [PATCH 7/8] Altered some formatting issues from previous commit. fixes #2 --- README.md | 18 +----------------- 1 file changed, 1 insertion(+), 17 deletions(-) diff --git a/README.md b/README.md index 0ba87f0..6a132f7 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,9 @@ **AI Powered OCR Code Recognition from Video Tutorials** -<<<<<<< HEAD [![Build](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/build.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/build.yml) [![Tests](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/tests.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/tests.yml) [![Accessibility](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/accesibility.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/accesibility.yml) -======= -[![Build](https://github.com/NM-TAFE/dip-project-ocrroo/actions/workflows/build.yml/badge.svg)](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/build.yml) -[![Tests](https://github.com/NM-TAFE/dip-project-ocrroo/actions/workflows/tests.yml/badge.svg)](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/tests.yml) -[![Accessibility](https://github.com/NM-TAFE/dip-project-ocrroo/actions/workflows/accesibility.yml/badge.svg)](https://github.com/NM-TAFE/dip-project-ocrroo/actions/workflows/accesibility.yml) ->>>>>>> 81db8f791d91688abd0dacc35e0d7c2e0c764791 @@ -40,13 +34,8 @@ The program reads code from videos to assist visually impaired developers in usi ## Installation -<<<<<<< HEAD To install and run this project, please follow the [Installation Guide](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki/Installation-Guide) in the [Wiki](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki). -======= -To install and run this project, please follow the [Installation Guide](https://github.com/NM-TAFE/dip-project-ocrroo/wiki/Installation-Guide) -in the [Wiki](https://github.com/NM-TAFE/dip-project-ocrroo/wiki). ->>>>>>> 81db8f791d91688abd0dacc35e0d7c2e0c764791 #### Basic Installation @@ -120,7 +109,7 @@ To run the application with silenced debug/logging output, execute the following Update the above configuration variables into the below file: ```bash - config.ini + app/config.ini ``` ## Running the Project @@ -140,13 +129,8 @@ To run the application with debug/logging output in the console, use the followi ## Contributing -<<<<<<< HEAD To contribute to this project, please follow the [Contribution Guide](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki/Contributor's-Guide) in the [Wiki](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki). -======= -To contribute to this project, please follow the [Contribution Guide](https://github.com/NM-TAFE/dip-project-ocrroo/wiki/wiki/Contribution-Guide) -in the [Wiki](https://github.com/NM-TAFE/dip-project-ocrroo/wiki). ->>>>>>> 81db8f791d91688abd0dacc35e0d7c2e0c764791 ## Code of Conduct From 4321ca4305f174662cfe1fef010a4ec3f15383b5 Mon Sep 17 00:00:00 2001 From: Rumsie-Grimshaw Date: Wed, 29 May 2024 20:04:09 +0800 Subject: [PATCH 8/8] Fixed badge image and links to correctly direct to the architects project pages. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6a132f7..89b7139 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,9 @@ **AI Powered OCR Code Recognition from Video Tutorials** -[![Build](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/build.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/build.yml) -[![Tests](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/tests.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/tests.yml) -[![Accessibility](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/accesibility.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/accesibility.yml) +[![Build](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/build.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/build.yml) +[![Tests](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/tests.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/tests.yml) +[![Accessibility](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/accesibility.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/accesibility.yml)