Skip to content

SP-21549: Upcoming deprecation webclient #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 24, 2025
Merged

SP-21549: Upcoming deprecation webclient #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e1bb73
SP-21549: Upcoming deprecation webclient
GubinAlexander Mar 21, 2025
6022339
Update README.md
GubinAlexander Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
[![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
Expand All @@ -14,21 +18,21 @@ We are always thrilled to receive pull requests, and do our best to process them
See [dev guide](./dev.md)

## Install package
`regula.documentreader.webclient` is on the Python Package Index (PyPI):
`regula_documentreader_webclient` is on the Python Package Index (PyPI):

```bash
pip install regula.documentreader.webclient
pip install regula_documentreader_webclient
```

Or using `pipenv`
```bash
pipenv install regula.documentreader.webclient
pipenv install regula_documentreader_webclient
```

## Example
Performing request:
```python
from regula.documentreader.webclient import *
from regula_documentreader_webclient import *

with open("australia_passport.jpg", "rb") as f:
input_image = f.read()
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
long_description = fh.read()

setup(
name="regula.documentreader.webclient",
name="regula_documentreader_webclient",
version=os.getenv("PACKAGE_VERSION_TO_PUBLISH", "7.4.45"),
python_requires=">=3.8",
description="Regula's Document Reader python client",
Expand Down