regula-documentreader-webclient


Nameregula-documentreader-webclient JSON
Version 8.2.440 PyPI version JSON
download
home_pagehttps://regulaforensics.com
SummaryRegula's Document Reader python client
upload_time2025-07-24 17:48:12
maintainerNone
docs_urlNone
authorRegula Forensics, Inc.
requires_python>=3.9
licenseNone
keywords document-reader-client document reader document recognition regulaforensics regula
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Regula Document Reader web API Python 3.9+ 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)
[![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://api.regulaforensics.com/)

## ⚠️ 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](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.
See [dev guide](./dev.md)

## Install package
`regula_documentreader_webclient` is on the Python Package Index (PyPI):

```bash
pip install regula_documentreader_webclient
```

Or using `pipenv`
```bash
pipenv install regula_documentreader_webclient
```

## Example
Performing request:
```python
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:
```python
# 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](./example) folder.

Raw data

            {
    "_id": null,
    "home_page": "https://regulaforensics.com",
    "name": "regula-documentreader-webclient",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "document-reader-client, document reader, document recognition, regulaforensics, regula",
    "author": "Regula Forensics, Inc.",
    "author_email": "support@regulaforensics.com",
    "download_url": "https://files.pythonhosted.org/packages/84/2c/57051cca17e5f2f266f18876e2b179f76a9cf9012c85cbb8ed5c76a8540c/regula_documentreader_webclient-8.2.440.tar.gz",
    "platform": null,
    "description": "# Regula Document Reader web API Python 3.9+ client\n\n[![pypi](https://img.shields.io/pypi/v/regula.documentreader.webclient?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)\n[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi)\n[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)\n[![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://api.regulaforensics.com/)\n\n## \u26a0\ufe0f Warning: Package Name Changed\n\nPackage name has been changed from `regula.documentreader.webclient` to `regula_documentreader_webclient`\n\nDocuments recognition as easy as reading two bytes.\n\nIf you have any problems with or questions about this client, please contact us\nthrough a [GitHub issue](https://github.com/regulaforensics/DocumentReader-web-python-client/issues).\nYou 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;\nWe are always thrilled to receive pull requests, and do our best to process them as fast as we can.\nSee [dev guide](./dev.md)\n\n## Install package\n`regula_documentreader_webclient` is on the Python Package Index (PyPI):\n\n```bash\npip install regula_documentreader_webclient\n```\n\nOr using `pipenv`\n```bash\npipenv install regula_documentreader_webclient\n```\n\n## Example\nPerforming request:\n```python\nfrom regula_documentreader_webclient import *\n\nwith open(\"australia_passport.jpg\", \"rb\") as f:\n    input_image = f.read()\n\nwith DocumentReaderApi(host='http://localhost:8080') as api:\n    params = ProcessParams(\n        scenario=Scenario.FULL_PROCESS,\n        result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]\n    )\n    request = RecognitionRequest(process_params=params, images=[input_image])\n    response = api.process(request)\n```\n\nParsing results:\n```python\n# status examples\nresponse_status = response.status\ndoc_overall_status = \"valid\" if response_status.overall_status == CheckResult.OK else \"not valid\"\n\n# text fields example\ndoc_number_field = response.text.get_field(TextFieldType.DOCUMENT_NUMBER)\ndoc_number_mrz = doc_number_field.get_value()\ndoc_number_visual = doc_number_field.get_value(Source.VISUAL)\ndoc_number_visual_validity = doc_number_field.source_validity(Source.VISUAL)\ndoc_number_mrz_validity = doc_number_field.source_validity(Source.MRZ)\ndoc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)\n\n# images fields example\nnormalized_input_image = response.images.document_image()\nportrait_field = response.images.get_field(GraphicFieldType.PORTRAIT)\nportrait_from_visual = portrait_field.get_value(Source.VISUAL)\nportrait_from_rfid = portrait_field.get_value(Source.RFID, original=True)\n```\nYou can find more detailed guide and run this sample in [example](./example) folder.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Regula's Document Reader python client",
    "version": "8.2.440",
    "project_urls": {
        "Homepage": "https://regulaforensics.com"
    },
    "split_keywords": [
        "document-reader-client",
        " document reader",
        " document recognition",
        " regulaforensics",
        " regula"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "210f258a61980074abf26d5ea6c553b800b034e66d82c4c3e1854c36285be2bf",
                "md5": "4801ffcd0ae611d1e19968212c0ba4a3",
                "sha256": "b8d41c9f8c84ebe572ff43b50274161d29c6b3ac9440a0b35860de813c3a1a52"
            },
            "downloads": -1,
            "filename": "regula_documentreader_webclient-8.2.440-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4801ffcd0ae611d1e19968212c0ba4a3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 368864,
            "upload_time": "2025-07-24T17:48:10",
            "upload_time_iso_8601": "2025-07-24T17:48:10.113428Z",
            "url": "https://files.pythonhosted.org/packages/21/0f/258a61980074abf26d5ea6c553b800b034e66d82c4c3e1854c36285be2bf/regula_documentreader_webclient-8.2.440-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "842c57051cca17e5f2f266f18876e2b179f76a9cf9012c85cbb8ed5c76a8540c",
                "md5": "a917c59d2c2127d5f7bfcda489d92f9c",
                "sha256": "575ea0539283cf11a56956a816df1c2f619b0a4eddc8b57e833badf1d2c8c553"
            },
            "downloads": -1,
            "filename": "regula_documentreader_webclient-8.2.440.tar.gz",
            "has_sig": false,
            "md5_digest": "a917c59d2c2127d5f7bfcda489d92f9c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 130307,
            "upload_time": "2025-07-24T17:48:12",
            "upload_time_iso_8601": "2025-07-24T17:48:12.525312Z",
            "url": "https://files.pythonhosted.org/packages/84/2c/57051cca17e5f2f266f18876e2b179f76a9cf9012c85cbb8ed5c76a8540c/regula_documentreader_webclient-8.2.440.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-24 17:48:12",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "regula-documentreader-webclient"
}
Regula Forensics, Inc.
Elapsed time: 0.94540s