Skip to content

Commit 8513903

Browse files
Merge pull request #194 from regulaforensics/SP-21549/Upcoming_deprecation_webclient
SP-21549: Upcoming deprecation webclient
2 parents 2837cc5 + 6022339 commit 8513903

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
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+
## ⚠️ Warning: Package Name Changed
9+
10+
Package name has been changed from `regula.documentreader.webclient` to `regula_documentreader_webclient`
11+
812
Documents recognition as easy as reading two bytes.
913

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

1620
## Install package
17-
`regula.documentreader.webclient` is on the Python Package Index (PyPI):
21+
`regula_documentreader_webclient` is on the Python Package Index (PyPI):
1822

1923
```bash
20-
pip install regula.documentreader.webclient
24+
pip install regula_documentreader_webclient
2125
```
2226

2327
Or using `pipenv`
2428
```bash
25-
pipenv install regula.documentreader.webclient
29+
pipenv install regula_documentreader_webclient
2630
```
2731

2832
## Example
2933
Performing request:
3034
```python
31-
from regula.documentreader.webclient import *
35+
from regula_documentreader_webclient import *
3236

3337
with open("australia_passport.jpg", "rb") as f:
3438
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)