Merge pull request #25 from brain-facens/develop

Develop

Author: nata-vito

.github/workflows/python-app.yml

@@ -5,9 +5,9 @@ name: Python application
 
 on:
   push:
-    branches: [ "master" ]
+    branches: [ "main", "develop" ]
   pull_request:
-    branches: [ "master" ]
+    branches: [ "main", "develop" ]
 
 permissions:
   contents: read
@@ -34,6 +34,8 @@ jobs:
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Run api
+      run: python src/field_vision_api/main.py     
     - name: Test with pytest
       run: |
         pytest

.gitignore

@@ -1,6 +1,6 @@
 *.drawio
 __pycache__/
-
+.pytest_cache/
 node_modules/
 .expo/
 dist/

README.md

@@ -4,6 +4,9 @@ https://github.com/brain-facens/OCR-notas/assets/64169072/8078be88-cb17-4616-9e0
 
 API for processing text on invoices, with the aim of identifying relevant fields on an invoice and optimizing bonus or validation systems. Making life easier for logisticians, merchants and managers, the application has an interface that captures images from the webcam, processes the image using OCR and provides a visualization of the results obtained.
 
+## Docs
+[Visit our wiki](https://github.com/brain-facens/FieldVision-AI/wiki)
+
 ## First Steps
 
 This project was developed to run a web interface, where the user will have access to the image capture system and the data processed from that image. Follow the steps below to use this project, the stable version is in the main branch.
@@ -20,10 +23,10 @@ The following requirements should ideally be met for proper operation:
 - Create a virtual environment for the project if you want to work without conda;
 
   ```
-  conda create --name paddle_env python=3.8 --channel https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/free/
+  conda create --name fielvision python=3.8 --channel https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/free/
 
   # Activate the environment
-  conda activate paddle_env
+  conda activate fielvision
   ```
 
 ---
@@ -38,11 +41,13 @@ Local:
 
 ```
 # Activate the environment
-conda activate paddle_env
+conda activate fielvision
 
-git clone https://github.com/brain-facens/OCR-notas.git
+# Clone repository
+git clone https://github.com/brain-facens/FieldVision-AI.git
 
-cd OCR-notas
+# Install requirements
+cd FieldVision-AI/
 pip install -r requirements.txt
 ```
 
@@ -58,8 +63,11 @@ docker pull brain20/ocr-notas
 Local:
 
 ```
-# applicable filter of up to 3 words
-python main.py --filter <fist,second,third,...>
+# Applicable filter of up to 3 words 
+# python src/field_vision_API/main.py <fist, second, third>
+
+# Run API
+python src/field_vision_API/main.py
 ```
 
 Docker:

requirements.txt

@@ -1,22 +1,11 @@
-shapely
-scikit-image
-imgaug
-pyclipper
-lmdb
-tqdm
-numpy
-visualdl
-rapidfuzz
-opencv-python<=4.6.0.66
-opencv-contrib-python<=4.6.0.66
-cython
-lxml
-premailer
-openpyxl
-attrdict
-PyMuPDF<1.21.0
-Pillow
-pyyaml
-fastapi[all]
-paddleocr
-paddlepaddle
+paddleocr==2.7.0.3
+typing==3.7.4.3
+numpy==1.24.4
+fastapi==0.104.0
+pydantic==2.4.2
+uvicorn==0.23.2
+opencv-python==4.6.0.66
+paddlepaddle==2.5.1
+python-multipart==0.0.6
+requests==2.31.0
+pytest==7.4.3

src/README.md

@@ -0,0 +1,2 @@
+# src
+

src/field_vision_api/README.md

@@ -0,0 +1,79 @@
+# FieldVision API
+API for processing text on invoices, with the aim of identifying relevant fields on an invoice and optimizing bonus or validation systems. Making life easier for logisticians, merchants and managers, the application has an interface that captures images from the webcam, processes the image using OCR and provides a visualization of the results obtained.
+
+Follow the steps bellow to install the FieldVision API:
+
+```
+# Clone repository
+git clone https://github.com/brain-facens/FieldVision-AI.git
+
+# Install requirements
+cd FieldVision-AI/
+pip install -r requirements.txt
+
+# Run API
+python src/field_vision_API/main.py
+```
+
+## API Methods
+Below are the methods present in the FieldVision API and their respective functions.
+
+| API Call | Action|
+|----------|-------|
+| GET / | Home path |
+| GET /v1/result/ | Get the filtered result |
+| GET /v1/raw_result/ | Get the latest raw result |
+| GET /v1/filter/ | Get the latest word filter |
+| POST /v1/post_image/ | Upload image |
+| PUT /v1/filter/ | Update the filter |
+
+
+
+
+## Example Request Scripts
+Below are the scripts that make it possible to request the methods present in the API.
+
+#### **GET** methods:
+
+```
+import pytest
+import requests
+
+def test_api_call_root(url = <API_url>):
+    response = requests.get(url)
+    return response
+```
+---
+#### **PUT** methods:
+
+```
+import pytest
+import requests
+
+def test_api_put_result(url = <API_url>):
+    payload={
+        "filter": [
+            "total"
+        ]
+    }
+
+    response = requests.put(url, json=payload)
+   return response
+```
+---
+#### **POST** methods:
+
+```
+import pytest
+import requests
+
+def test_api_put_result(url = <API_url>):
+    payload={
+        "filter": [
+            "total"
+        ]
+    }
+
+    response = requests.put(url, json=payload)
+    return response
+```

src/field_vision_api/__init__.py

@@ -23,7 +23,7 @@
 from fastapi import FastAPI, File, UploadFile
 from pydantic import BaseModel # E0611, pylint: disable=no-name-in-module
 import uvicorn
-from utils import (ocr_process, filter_process, read_imagefile,
+from util.utils import (ocr_process, filter_process, read_imagefile, # E0401, pylint: disable=import-error
                     list_of_strings, Results, Filter)
 
 

src/field_vision_api/core/__init__.py

@@ -198,12 +198,16 @@
 &nbsp;<br>
 ...<br>
 Args:<br>
-&nbsp;&nbsp;&nbsp;&nbsp;img:&nbsp;image&nbsp;to&nbsp;process.<br>
-&nbsp;<br>
-Returns:<br>
-&nbsp;&nbsp;&nbsp;&nbsp;Result&nbsp;of&nbsp;OCR&nbsp;processing&nbsp;on&nbsp;the&nbsp;image.</tt></dd></dl>
- <dl><dt><a name="-read_imagefile"><strong>read_imagefile</strong></a>(data)</dt><dd><tt>Image&nbsp;processing.<br>
-&nbsp;<br>
+&nbsp;&nbsp;&nbsp;&nbsp;Frame&nbsp;with&nbsp;rgb&nbsp;color&nbsp;pattern&nbsp;and&nbsp;processed&nbsp;from&nbsp;byte&nbsp;array&nbsp;to&nbsp;ndarray.</tt></dd></dl>
+</td></tr></table><p>
+<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
+<tr bgcolor="#55aa55">
+<td colspan=3 valign=bottom>&nbsp;<br>
+<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
+    
+<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
+<td width="100%"><strong>List</strong> = typing.List</td></tr></table>
+</body></html>
 ...<br>
 Args:<br>
 &nbsp;&nbsp;&nbsp;&nbsp;data:&nbsp;API&nbsp;buffer&nbsp;image.<br>

python_scripts/main.py renamed to src/field_vision_api/main.py

@@ -55,7 +55,7 @@ def __init__(self, filter_:List[str]) -> None:
         """
         self._filter_words = filter_
 
-    def set_filter(self, new_filter):
+    def set_filter(self, new_filter) -> None:
         """ 
         Setter for filter words.
 
@@ -68,7 +68,7 @@ def set_filter(self, new_filter):
         """
         self._filter_words = new_filter
 
-    def get_filter(self) -> List:
+    def get_filter(self) -> list:
         """ 
         Getter for filter words.
 
@@ -126,7 +126,7 @@ def set_results(self, new_results) -> None:
         """
         self._results = new_results
 
-    def get_results(self) -> List:
+    def get_results(self) -> list:
         """ 
         Getter for OCR processing results.
 
@@ -140,7 +140,7 @@ def get_results(self) -> List:
         return self._results
 
 
-def list_of_strings(arg) -> List:
+def list_of_strings(arg) -> list:
     """ 
     Get list of strings from user's filter input.
 
@@ -170,7 +170,7 @@ def read_imagefile(data) -> np.ndarray:
     cv2.cvtColor(frame, cv2.COLOR_BGR2RGB) # E1101, pylint: disable=no-member
     return frame
 
-def ocr_process(img) -> List:
+def ocr_process(img) -> list:
     """ 
     OCR processing.
 
@@ -186,7 +186,7 @@ def ocr_process(img) -> List:
     return result
 
 
-def filter_process(result, phrases) -> List:
+def filter_process(result, phrases) -> list:
     """ 
     Filter processing.
 

docs/utils.html renamed to src/field_vision_api/util/README.md

@@ -0,0 +1,64 @@
+## Test Cases for API Testing
+To test the API, some test cases were created, which are shown in the table below.
+
+| Test Scenario Category | Test Action Category | Test Action Description |
+|------------------------|----------------------|-------------------------|
+| ***1 Basic Positive Tests*** |||
+| Execute API call with valid required parameters| Validate status code:| 1. All requests should return 2XX HTTP status code <br> 2. Returned status code is according to spec: <br> - 200 OK for **GET**, **POST** and **PUT** request <br> 3. Validate returns with expected API data: <br> - **GET** /, returns: Information for user to found the API docs <br> - **GET** /v1/result/, returns: Information for user to found the API docs <br> - **GET** /v1/raw_result/, returns: Latest OCR processing raw result <br> - **GET** /v1/filter/, returns the latest word filter on API <br> - **POST** /v1/post_image/, returns: Information for user to found the API docs <br> - **PUT** /v1/filter/, returns: The new filter |
+
+To run the tests, the API must be running. After checking this, run the commands below:
+```
+# Go to the repository's root folder
+cd FieldVision-AI
+
+# Run pytest
+pytest
+```
+---
+
+## Example Test scripts
+
+How to test **GET** methods:
+
+```
+import pytest
+import requests
+
+def test_api_call_root(url = <API_url>):
+    response = requests.get(url)
+    assert response.status_code == 200, "Failed!"
+```
+---
+How to test **PUT** methods:
+
+```
+import pytest
+import requests
+
+def test_api_put_result(url = <API_url>):
+    payload={
+        "filter": [
+            "total"
+        ]
+    }
+
+    response = requests.put(url, json=payload)
+    assert response.status_code == 200, "Failed!"
+```
+---
+How to test **POST** methods:
+
+```
+import pytest
+import requests
+
+def test_api_put_result(url = <API_url>):
+    payload={
+        "filter": [
+            "total"
+        ]
+    }
+
+    response = requests.put(url, json=payload)
+    assert response.status_code == 200, "Failed!"
+```

src/field_vision_api/util/__init__.py

@@ -0,0 +1,22 @@
+""" 
+Script to test GET method endpoint /v1/filter/.
+"""
+
+import pytest # W0611, pylint: disable=unused-import
+import requests
+
+def test_api_get_filter(url = "http://0.0.0.0:8085/v1/filter/") -> None:
+    """ 
+    Test for endpoint filter result /v1/filter/.
+
+    ...
+    Args:
+        url: API url.
+
+    Returns:
+        None.
+    """
+    response = requests.get(url, timeout=10)
+    assert response.status_code == 200, "Failed!\n"
+    response = response.json()
+    assert response['latest_filter'] is None, 'Result error!\n'

python_scripts/utils.py renamed to src/field_vision_api/util/utils.py

@@ -0,0 +1,21 @@
+""" 
+Script to test GET method endpoint /v1/raw_result/.
+"""
+import pytest # W0611, pylint: disable=unused-import
+import requests
+
+def test_api_get_raw_result(url = "http://0.0.0.0:8085/v1/raw_result/"):
+    """ 
+    Test for endpoint raw result /v1/raw_result/.
+
+    ...
+    Args:
+        url: API url.
+
+    Returns:
+        None.
+    """
+    response = requests.get(url, timeout=10)
+    assert response.status_code == 200, "Failed!"
+    response = response.json()
+    assert isinstance(response['latest_result'], list), 'Result error!'