Merge pull request #923 from drikusroor/add-flake8-workflow

Add flake8 linter workflow

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Unit Tests
+name: Python CI
 
 on:
   push:
@@ -30,6 +30,10 @@ jobs:
         python -m pip install --upgrade pip
         pip install -r requirements.txt
 
+    - name: Lint with flake8
+      continue-on-error: true
+      run: flake8 scripts/ tests/
+
     - name: Run unittest tests with coverage
       run: |
         coverage run --source=scripts -m unittest discover tests

.gitignore

@@ -18,4 +18,4 @@ log.txt
 # Coverage reports
 .coverage
 coverage.xml
-htmlcov/
+htmlcov/

README.md

@@ -96,9 +96,10 @@ pip install -r requirements.txt
 ```
 
 4. Rename `.env.template` to `.env` and fill in your `OPENAI_API_KEY`. If you plan to use Speech Mode, fill in your `ELEVEN_LABS_API_KEY` as well.
-  - Obtain your OpenAI API key from: https://platform.openai.com/account/api-keys.
+
-  - Obtain your ElevenLabs API key from: https://elevenlabs.io. You can view your xi-api-key using the "Profile" tab on the website.
+- Obtain your OpenAI API key from: https://platform.openai.com/account/api-keys.
-  - If you want to use GPT on an Azure instance, set `USE_AZURE` to `True` and provide the `OPENAI_AZURE_API_BASE`, `OPENAI_AZURE_API_VERSION` and `OPENAI_AZURE_DEPLOYMENT_ID` values as explained here: https://pypi.org/project/openai/ in the `Microsoft Azure Endpoints` section. Additionally you need separate deployments for both embeddings and chat. Add their ID values to `OPENAI_AZURE_CHAT_DEPLOYMENT_ID` and `OPENAI_AZURE_EMBEDDINGS_DEPLOYMENT_ID` respectively
+- Obtain your ElevenLabs API key from: https://elevenlabs.io. You can view your xi-api-key using the "Profile" tab on the website.
+- If you want to use GPT on an Azure instance, set `USE_AZURE` to `True` and provide the `OPENAI_AZURE_API_BASE`, `OPENAI_AZURE_API_VERSION` and `OPENAI_AZURE_DEPLOYMENT_ID` values as explained here: https://pypi.org/project/openai/ in the `Microsoft Azure Endpoints` section. Additionally you need separate deployments for both embeddings and chat. Add their ID values to `OPENAI_AZURE_CHAT_DEPLOYMENT_ID` and `OPENAI_AZURE_EMBEDDINGS_DEPLOYMENT_ID` respectively
 
 ## 🔧 Usage
 
@@ -113,9 +114,11 @@ python scripts/main.py
 3. To exit the program, type "exit" and press Enter.
 
 ### Logs
-You will find activity and error logs in the folder ```./logs```
+
+You will find activity and error logs in the folder `./logs`
 
 To output debug logs:
+
 ```
 python scripts/main.py --debug
 ```
@@ -331,3 +334,11 @@ To run tests and see coverage, run the following command:
 ```
 coverage run -m unittest discover tests
 ```
+
+## Run linter
+
+This project uses [flake8](https://flake8.pycqa.org/en/latest/) for linting. To run the linter, run the following command:
+
+```
+flake8 scripts/ tests/
+```

main.py

@@ -1 +1 @@
-from scripts.main import main
+from scripts.main import main

requirements.txt

@@ -15,4 +15,5 @@ pinecone-client==2.2.1
 redis
 orjson
 Pillow
-coverage
+coverage
+flake8

tests/context.py

@@ -2,4 +2,4 @@ import sys
 import os
 
 sys.path.insert(0, os.path.abspath(
-    os.path.join(os.path.dirname(__file__), '../scripts')))
+    os.path.join(os.path.dirname(__file__), '../scripts')))