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
Metadata
1 maintainer
Release files for regula-documentreader-webclient 9.10.1106.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 | Provenance | Actions |
|---|---|---|---|---|
| regula_documentreader_webclient-9.10.1106.dev0.tar.gz | 147.8 kB | Without provenance | Details for regula_documentreader_webclient-9.10.1106.dev0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| regula_documentreader_webclient-9.10.1106.dev0-py3-none-any.whl | Python 3 | none | any | Details for regula_documentreader_webclient-9.10.1106.dev0-py3-none-any.whl |
Total release size: 573.6 kB
Release files / regula_documentreader_webclient-9.10.1106.dev0.tar.gz
| Download URL | regula_documentreader_webclient-9.10.1106.dev0.tar.gz |
|---|---|
| Size | 147.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
03be44513438893d28313a516883def33c175cb796fa0b47110383056d46c447
|
|
BLAKE2b-256 checksum How to use checksums |
04e9eb23d90e0864978b74b4c5b30043a63fbbb9c6e1c929f87ddd82ba1edc16
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.14
|
Release files / regula_documentreader_webclient-9.10.1106.dev0-py3-none-any.whl
| Download URL | regula_documentreader_webclient-9.10.1106.dev0-py3-none-any.whl |
|---|---|
| Size | 425.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ac71d2088bb63a2d0462a6162fcdcf0791132d2883f6c2f4027fd9e0803844e3
|
|
BLAKE2b-256 checksum How to use checksums |
5fb442f433ceed03ea6a791a9efbe554d178cbd37b9e877adcf214624a669822
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.14
|
Security for regula-documentreader-webclient 9.10.1106.dev0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
