⬆️ add simple non-regression testing (#183)

Author: sebastianMindee

.github/workflows/test.yml

@@ -47,5 +47,7 @@ jobs:
         pip install -e .[test]
 
     - name: Testing the code with pytest
+      env:
+        MINDEE_API_KEY: ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
       run: |
         pytest

README.md

@@ -123,7 +123,7 @@ api_response = mindee_client.parse(
 ## Further Reading
 Complete details on the working of the library are available in the following guides:
 
-* [Python Getting started](https://developers.mindee.com/docs/python-getting-started)
+* [Getting started](https://developers.mindee.com/docs/python-getting-started)
 * [Python Command Line Interface (CLI)](https://developers.mindee.com/docs/python-cli)
 * [Python Custom APIs (API Builder)](https://developers.mindee.com/docs/python-api-builder)
 * [Python Invoice OCR](https://developers.mindee.com/docs/python-invoice-ocr)
@@ -133,13 +133,13 @@ Complete details on the working of the library are available in the following gu
 * [Python Proof of Address OCR](https://developers.mindee.com/docs/python-proof-of-address-ocr)
 * [Python EU License Plate OCR](https://developers.mindee.com/docs/python-eu-license-plate-ocr)
 * [Python FR Bank Account Detail OCR](https://developers.mindee.com/docs/python-fr-bank-account-details-ocr)
-* [Python FR Carte Grise OCR](https://developers.mindee.com/docs/python-fr-carte-vitale-ocr)
+* [Python FR Carte Grise OCR](https://developers.mindee.com/docs/python-fr-carte-grise-ocr)
 * [Python FR Carte Vitale OCR](https://developers.mindee.com/docs/python-fr-carte-vitale-ocr)
 * [Python FR ID Card OCR](https://developers.mindee.com/docs/python-fr-id-card-ocr)
 * [Python FR Petrol Receipts OCR](https://developers.mindee.com/docs/python-fr-petrol-receipts-ocr)
 * [Python US Bank Check OCR](https://developers.mindee.com/docs/python-us-bank-checks-ocr)
-* [Python US W9 OCR](https://developers.mindee.com/docs/python-us-driver-license-ocr)
-* [Python US Driver License OCR](https://developers.mindee.com/docs/python-us-w9-ocr)
+* [Python US W9 OCR](https://developers.mindee.com/docs/python-us-w9-ocr)
+* [Python US Driver License OCR](https://developers.mindee.com/docs/python-us-driver-license-ocr)
 * [Python Barcode Reader API](https://developers.mindee.com/docs/python-barcode-reader-api)
 * [Python Cropper API](https://developers.mindee.com/docs/python-cropper-api)
 * [Python Invoice Splitter API](https://developers.mindee.com/docs/python-invoice-splitter-api)

docs/extras/guide/bank_account_details_v2.md

@@ -71,7 +71,7 @@ Page 0
 ## Standard Fields
 These fields are generic and used in several products.
 
-### Basic Field
+### BasicField
 Each prediction object contains a set of fields that inherit from the generic `BaseField` class.
 A typical `BaseField` object will have the following attributes:
 
@@ -87,7 +87,7 @@ A typical `BaseField` object will have the following attributes:
 
 Aside from the previous attributes, all basic fields have access to a custom `__str__` method that can be used to print their value as a string.
 
-### String Field
+### StringField
 The text field `StringField` only has one constraint: its **value** is an `Optional[str]`.
 
 ## Specific Fields
@@ -107,7 +107,7 @@ A `BankAccountDetailsV2Bban` implements the following attributes:
 The following fields are extracted for Bank Account Details V2:
 
 ## Account Holder's Names
-**account_holders_names** : Full extraction of the account holders names.
+**account_holders_names** ([StringField](#stringfield)): Full extraction of the account holders names.
 
 ```py
 print(result.document.inference.prediction.account_holders_names.value)
@@ -121,14 +121,14 @@ print(result.document.inference.prediction.bban.value)
 ```
 
 ## IBAN
-**iban** : Full extraction of the IBAN number.
+**iban** ([StringField](#stringfield)): Full extraction of the IBAN number.
 
 ```py
 print(result.document.inference.prediction.iban.value)
 ```
 
 ## SWIFT Code
-**swift_code** : Full extraction of the SWIFT code.
+**swift_code** ([StringField](#stringfield)): Full extraction of the SWIFT code.
 
 ```py
 print(result.document.inference.prediction.swift_code.value)

docs/extras/guide/bank_check_v1.md

@@ -71,7 +71,7 @@ Page 0
 ## Standard Fields
 These fields are generic and used in several products.
 
-### Basic Field
+### BasicField
 Each prediction object contains a set of fields that inherit from the generic `BaseField` class.
 A typical `BaseField` object will have the following attributes:
 
@@ -88,22 +88,22 @@ A typical `BaseField` object will have the following attributes:
 Aside from the previous attributes, all basic fields have access to a custom `__str__` method that can be used to print their value as a string.
 
 
-### Amount Field
+### AmountField
 The amount field `AmountField` only has one constraint: its **value** is an `Optional[float]`.
 
-### Date Field
+### DateField
 Aside from the basic `BaseField` attributes, the date field `DateField` also implements the following: 
 
 * **date_object** (`Date`): an accessible representation of the value as a python object. Can be `None`.
 
 
-### Position Field
+### PositionField
 The position field `PositionField` does not implement all the basic `BaseField` attributes, only **bounding_box**, **polygon** and **page_id**. On top of these, it has access to:
 
 * **rectangle** (`[Point, Point, Point, Point]`): a Polygon with four points that may be oriented (even beyond canvas).
 * **quadrangle** (`[Point, Point, Point, Point]`): a free polygon made up of four points.
 
-### String Field
+### StringField
 The text field `StringField` only has one constraint: its **value** is an `Optional[str]`.
 
 ## Page-Level Fields
@@ -113,58 +113,58 @@ Some fields are constrained to the page level, and so will not be retrievable to
 The following fields are extracted for Bank Check V1:
 
 ## Account Number
-**account_number** : The check payer's account number.
+**account_number** ([StringField](#stringfield)): The check payer's account number.
 
 ```py
 print(result.document.inference.prediction.account_number.value)
 ```
 
 ## Amount
-**amount** : The amount of the check.
+**amount** ([AmountField](#amountfield)): The amount of the check.
 
 ```py
 print(result.document.inference.prediction.amount.value)
 ```
 
 ## Check Number
-**check_number** : The issuer's check number.
+**check_number** ([StringField](#stringfield)): The issuer's check number.
 
 ```py
 print(result.document.inference.prediction.check_number.value)
 ```
 
 ## Check Position
-[📄](#page-level-fields "This field is only present on individual pages.")**check_position** : The position of the check on the document.
+[📄](#page-level-fields "This field is only present on individual pages.")**check_position** ([PositionField](#positionfield)): The position of the check on the document.
 
 ```py
 for check_position_elem of result.document.check_position:
     print(check_position_elem.polygon)
 ```
 
 ## Check Issue Date
-**date** : The date the check was issued.
+**date** ([DateField](#datefield)): The date the check was issued.
 
 ```py
 print(result.document.inference.prediction.date.value)
 ```
 
 ## Payees
-**payees** : List of the check's payees (recipients).
+**payees** (List[[StringField](#stringfield)]): List of the check's payees (recipients).
 
 ```py
 for payees_elem in result.document.inference.prediction.payees:
     print(payees_elem.value)
 ```
 
 ## Routing Number
-**routing_number** : The check issuer's routing number.
+**routing_number** ([StringField](#stringfield)): The check issuer's routing number.
 
 ```py
 print(result.document.inference.prediction.routing_number.value)
 ```
 
 ## Signature Positions
-[📄](#page-level-fields "This field is only present on individual pages.")**signatures_positions** : List of signature positions
+[📄](#page-level-fields "This field is only present on individual pages.")**signatures_positions** (List[[PositionField](#positionfield)]): List of signature positions
 
 ```py
 for page in result.document.inference.pages:

docs/extras/guide/barcode_reader_v1.md

@@ -61,7 +61,7 @@ Page 0
 ## Standard Fields
 These fields are generic and used in several products.
 
-### Basic Field
+### BasicField
 Each prediction object contains a set of fields that inherit from the generic `BaseField` class.
 A typical `BaseField` object will have the following attributes:
 
@@ -77,22 +77,22 @@ A typical `BaseField` object will have the following attributes:
 
 Aside from the previous attributes, all basic fields have access to a custom `__str__` method that can be used to print their value as a string.
 
-### String Field
+### StringField
 The text field `StringField` only has one constraint: its **value** is an `Optional[str]`.
 
 # Attributes
 The following fields are extracted for Barcode Reader V1:
 
 ## Barcodes 1D
-**codes_1d** : List of decoded 1D barcodes.
+**codes_1d** (List[[StringField](#stringfield)]): List of decoded 1D barcodes.
 
 ```py
 for codes_1d_elem in result.document.inference.prediction.codes_1d:
     print(codes_1d_elem.value)
 ```
 
 ## Barcodes 2D
-**codes_2d** : List of decoded 2D barcodes.
+**codes_2d** (List[[StringField](#stringfield)]): List of decoded 2D barcodes.
 
 ```py
 for codes_2d_elem in result.document.inference.prediction.codes_2d: