{"id":22400072,"url":"https://github.com/regulaforensics/documentreader-web-python-client","last_synced_at":"2025-12-30T10:53:02.573Z","repository":{"id":41999758,"uuid":"279251493","full_name":"regulaforensics/DocumentReader-web-python-client","owner":"regulaforensics","description":"Regula Document Reader web API Python 3.5+ client","archived":false,"fork":false,"pushed_at":"2025-06-11T09:56:30.000Z","size":6061,"stargazers_count":19,"open_issues_count":0,"forks_count":10,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2025-06-11T10:45:38.668Z","etag":null,"topics":["barcode-reader","document-reader","document-recognition","idcard","mrz","mrz-codes","ocr","passport","pypi","python","regula","regulaforensics"],"latest_commit_sha":null,"homepage":"https://regulaforensics.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regulaforensics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-07-13T09:04:35.000Z","updated_at":"2025-06-11T09:33:50.000Z","dependencies_parsed_at":"2023-10-12T23:34:30.427Z","dependency_job_id":"741d8097-e297-4198-8e1c-a5b89146e3e5","html_url":"https://github.com/regulaforensics/DocumentReader-web-python-client","commit_stats":null,"previous_names":[],"tags_count":68,"template":false,"template_full_name":null,"purl":"pkg:github/regulaforensics/DocumentReader-web-python-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-python-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-python-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-python-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-python-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regulaforensics","download_url":"https://codeload.github.com/regulaforensics/DocumentReader-web-python-client/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-python-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259804867,"owners_count":22913902,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["barcode-reader","document-reader","document-recognition","idcard","mrz","mrz-codes","ocr","passport","pypi","python","regula","regulaforensics"],"created_at":"2024-12-05T08:11:11.452Z","updated_at":"2025-12-30T10:53:02.533Z","avatar_url":"https://github.com/regulaforensics.png","language":"Python","readme":"# 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## ⚠️ 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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-python-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-python-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-python-client/lists"}