Skip to content

Commit 4e1bb73

Browse files
SP-21549: Upcoming deprecation webclient
1 parent 2837cc5 commit 4e1bb73

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
66
[![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://api.regulaforensics.com/)
77

8+
## Package name has been changed from `regula.documentreader.webclient` to `regula_documentreader_webclient`
9+
810
Documents recognition as easy as reading two bytes.
911

1012
If you have any problems with or questions about this client, please contact us
@@ -14,21 +16,21 @@ We are always thrilled to receive pull requests, and do our best to process them
1416
See [dev guide](./dev.md)
1517

1618
## Install package
17-
`regula.documentreader.webclient` is on the Python Package Index (PyPI):
19+
`regula_documentreader_webclient` is on the Python Package Index (PyPI):
1820

1921
```bash
20-
pip install regula.documentreader.webclient
22+
pip install regula_documentreader_webclient
2123
```
2224

2325
Or using `pipenv`
2426
```bash
25-
pipenv install regula.documentreader.webclient
27+
pipenv install regula_documentreader_webclient
2628
```
2729

2830
## Example
2931
Performing request:
3032
```python
31-
from regula.documentreader.webclient import *
33+
from regula_documentreader_webclient import *
3234

3335
with open("australia_passport.jpg", "rb") as f:
3436
input_image = f.read()

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
long_description = fh.read()
88

99
setup(
10-
name="regula.documentreader.webclient",
10+
name="regula_documentreader_webclient",
1111
version=os.getenv("PACKAGE_VERSION_TO_PUBLISH", "7.4.45"),
1212
python_requires=">=3.8",
1313
description="Regula's Document Reader python client",

0 commit comments

Comments
 (0)