This release is a pre-release and may not be stable for production use.
Regula Document Reader web API Python 3.9+ client
⚠️ Warning: Package Name Changed
Package name has been changed from regula.documentreader.webclient to regula_documentreader_webclient
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. You are invited to contribute new features, fixes, or updates, 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
Install package
regula_documentreader_webclient is on the Python Package Index (PyPI):
pip install regula_documentreader_webclient
Or using pipenv
pipenv install regula_documentreader_webclient
Example
Performing request:
from regula_documentreader_webclient import *
with open("australia_passport.jpg", "rb") as f:
input_image = f.read()
with DocumentReaderApi(host='http://localhost:8080') as api:
params = ProcessParams(
scenario=Scenario.FULL_PROCESS,
result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
)
request = RecognitionRequest(process_params=params, images=[input_image])
response = api.process(request)
Parsing results:
# status examples
response_status = response.status
doc_overall_status = "valid" if response_status.overall_status == CheckResult.OK else "not valid"
# text fields example
doc_number_field = response.text.get_field(TextFieldType.DOCUMENT_NUMBER)
doc_number_mrz = doc_number_field.get_value()
doc_number_visual = doc_number_field.get_value(Source.VISUAL)
doc_number_visual_validity = doc_number_field.source_validity(Source.VISUAL)
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.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 folder.
1 maintainer
Release files for regula-documentreader-webclient 9.9.1049.dev0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| regula_documentreader_webclient-9.9.1049.dev0.tar.gz | 146.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| regula_documentreader_webclient-9.9.1049.dev0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 571.3 kB
Release files / regula_documentreader_webclient-9.9.1049.dev0.tar.gz
| Download URL | regula_documentreader_webclient-9.9.1049.dev0.tar.gz |
|---|---|
| Size | 146.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6593220c3afd8cd5a0580511a8beaad772b454b8c45d1b8ff434b3f214c19cb6
|
|
BLAKE2b-256 checksum How to use checksums |
050dd422bc0aa89a59b7392206571930f95277dd9df3e6d1da264814e8e950b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.14
|
Release files / regula_documentreader_webclient-9.9.1049.dev0-py3-none-any.whl
| Download URL | regula_documentreader_webclient-9.9.1049.dev0-py3-none-any.whl |
|---|---|
| Size | 424.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6b0f07f1e5fdf5e9684fd961914e92010232938c334d13df3b0cd5ee5b6bc258
|
|
BLAKE2b-256 checksum How to use checksums |
55a8e47560d08d6f05fe45a91424c1cd814ec7d2785482ecefbc895cb2c2cbf1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.14
|
