Enhance documentation: fix comments - 1

Author: hleb-albau

README.md

@@ -1,14 +1,17 @@
 # Regula Document Reader web API Python 3.5+ client
 
 [![pypi](https://img.shields.io/pypi/v/regula.documentreader.webclient?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
+[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi)
 [![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
-[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-0a8c42?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi)
+[![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://api.regulaforensics.com/)
 
 Documents recognition as easy as reading two bytes.
 
 If you have any problems with or questions about this client, please contact us
 through a [GitHub issue](https://github.com/regulaforensics/DocumentReader-web-python-client/issues).
-You are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/DocumentReader-web-python-client/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), large or small; We are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+You are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/DocumentReader-web-python-client/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), large or small; 
+We are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+See [dev guide](./dev.md)
 
 ## Install package
 `regula.documentreader.webclient` is on the Python Package Index (PyPI):
@@ -35,7 +38,7 @@ with open("australia_passport.jpg", "rb") as f:
 with DocumentReaderApi(host='http://localhost:8080') as api:
     params = ProcessParams(
         scenario=Scenario.FULL_PROCESS,
-        result_type_output=[Result.RAW_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
+        result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
     )
     request = RecognitionRequest(process_params=params, images=[input_image])
     response = api.process(request)
@@ -56,24 +59,9 @@ doc_number_mrz_validity = doc_number_field.source_validity(Source.MRZ)
 doc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)
 
 # images fields example
-normalized_input_image = response.images.normalized_input_image()
+normalized_input_image = response.images.document_image()
 portrait_field = response.images.get_field(GraphicFieldType.PORTRAIT)
 portrait_from_visual = portrait_field.get_value(Source.VISUAL)
 portrait_from_rfid = portrait_field.get_value(Source.RFID, original=True)
 ```
 You can find more detailed guide and run this sample in [example](./example) folder.
-
-## Development
-
-To regenerate models, clone [latest OpenAPI definitions](https://github.com/regulaforensics/DocumentReader-web-openapi)
-and set `DEFINITION_FOLDER` as path to cloned directory, for example:
-```bash
-DEFINITION_FOLDER="/home/user/projects/DocumentReader-web-openapi"
-```
-Then use next command from the project root:
-```bash
-docker run --rm -v "${PWD}:/client" -v "${DEFINITION_FOLDER}:/definitions" \
-openapitools/openapi-generator-cli generate -g python \
--i /definitions/index.yml -o /client -c /client/generator-config.json \
--t /client/generator-templates
-```

dev.md

@@ -0,0 +1,14 @@
+# Development
+
+To regenerate models, clone [latest OpenAPI definitions](https://github.com/regulaforensics/DocumentReader-web-openapi)
+and set `DEFINITION_FOLDER` as path to cloned directory, for example:
+```bash
+DEFINITION_FOLDER="/home/user/projects/DocumentReader-web-openapi"
+```
+Then use next command from the project root:
+```bash
+docker run --rm -v "${PWD}:/client" -v "${DEFINITION_FOLDER}:/definitions" \
+openapitools/openapi-generator-cli generate -g python \
+-i /definitions/index.yml -o /client -c /client/generator-config.json \
+-t /client/generator-templates
+```

example/README.md

@@ -1,11 +1,13 @@
 # Regula Document Reader web API Python 3.5+ client
 
-## Running example
+Before you start: if you just want to play with an online demo, visit our [playground](https://api.regulaforensics.com).
+
+## Running local example
 
 Requirements:
 - installed python 3.5 or higher
 - installed [pipenv](https://pypi.org/project/pipenv)
-- running Regula Document Reader web application(todo link for docker run?) with trial license(todo edit desc here) 
+- running [Regula Document Reader web API with trial license](https://docs.regulaforensics.com/web/quick-start-guide)
 
 Cloning example
 ```bash
@@ -26,7 +28,7 @@ pipenv run python example.py
 API_BASE_PATH="http://192.168.0.101:8080" pipenv run python example.py
 ```
 
-This sample generate next text output:
+This sample generates next text output:
 ```text
     ---------------------------------------------------------------------------
                    Document Overall Status: not valid
@@ -37,7 +39,7 @@ This sample generate next text output:
               MRZ-Visual values comparison: 1
     ---------------------------------------------------------------------------
 ```
-Also, it creates [portrait](portraitFromVisual.jpg) and [normalized input](normalizedInputImage.jpg) 
+Also, it creates [portrait](portrait.jpg) and [document image](document-image.jpg) 
 pictures inside current folder.
 
 Edit on your own [example.py](./example.py), and re-run to see your results.

example/example.py

@@ -35,9 +35,9 @@
 
     # images fields example
     document_image = response.images.document_image()
-    portrait_Field = response.images.get_field(GraphicFieldType.PORTRAIT)
-    portrait_From_Visual = portrait_Field.get_value(Source.VISUAL)
-    with open('portrait.jpg', 'wb') as f: f.write(portrait_From_Visual)
+    portrait_field = response.images.get_field(GraphicFieldType.PORTRAIT)
+    portrait_from_visual = portrait_field.get_value(Source.VISUAL)
+    with open('portrait.jpg', 'wb') as f: f.write(portrait_from_visual)
     with open('document-image.jpg', 'wb') as f: f.write(document_image)
 
     # low-lvl(original) response