Skip to content

Commit 0c9a67f

Browse files
Update README
1 parent 0ea3df0 commit 0c9a67f

2 files changed

Lines changed: 65 additions & 32 deletions

File tree

README.md

Lines changed: 49 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,52 @@
1-
# Setu
2-
This package helps you work with Setu's deeplink APIs.
3-
* To generate a payment link
4-
* To check status of the payment link
1+
# Setu
2+
3+
SDK to help Pythonistas integrate with Setu's APIs
4+
5+
Currently the following APIs are supported.
6+
7+
- UPI DeepLinks
8+
9+
We're constantly adding new API support. Feel free to reach out to us if you
10+
can't see any API.
11+
12+
## Installation
13+
14+
```bash
15+
pip install setu
16+
```
517

618
## Usage
19+
20+
### UPI DeepLinks
21+
22+
The following actions are currently supported
23+
24+
- Generate payment link
25+
- Check status of payment link
26+
27+
#### Generate Link
28+
29+
```python
30+
from setu import deeplink
31+
32+
dl = deeplink.Deeplink(
33+
"YOUR SCHEME ID",
34+
"YOUR JWT SECRET",
35+
"YOUR PRODUCT INSTANCE ID",
36+
)
37+
link = dl.generate_link(2300, 4, "gb", "1231243")
38+
print(link["paymentLink"], link["platformBillID"])
739
```
8-
from setu import deeplink
9-
10-
dl = deeplink.Deeplink(
11-
"random-uuid-here", // SchemeId
12-
"another-uuid-here", // Secret
13-
"123123123123123", // Product instance ID
14-
)
15-
link = dl.generate_link(2300, 4, "gb", "1231243")
16-
print(link["paymentLink"], link["platformBillID"])
17-
status = dl.check_status(link['platformBillID'])
18-
print(status["status"])
19-
```
40+
41+
#### Generate Link
42+
43+
```python
44+
from setu import deeplink
45+
46+
status = dl.check_status(link['platformBillID'])
47+
print(status["status"])
48+
```
49+
50+
## License
51+
52+
MIT

setup.py

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
import pathlib
21
from setuptools import setup
32

4-
HERE = pathlib.Path(__file__).parent
3+
with open("README.md", "r") as fh:
4+
README = fh.read()
55

6-
README = (HERE / "README.md").read_text()
7-
8-
setup(name='setu',
9-
version='0.4.2',
10-
url='https://github.com/SetuHQ/setu-python-sdk',
11-
author='Gandharva B',
12-
author_email='gandharva@setu.co',
13-
description="SDK to help Pythonistas integrate with Setu's APIs",
14-
long_description=README,
15-
long_description_content_type="text/markdown",
16-
license='MIT',
17-
install_requires=["requests", "uuid", "PyJWT"],
18-
packages=['setu'],
19-
zip_safe=False)
6+
setup(
7+
name='setu',
8+
version='0.4.2',
9+
url='https://github.com/SetuHQ/setu-python-sdk',
10+
author='Setu',
11+
author_email='dev.support@setu.co',
12+
description="SDK to help Pythonistas integrate with Setu's APIs",
13+
long_description=README,
14+
long_description_content_type="text/markdown",
15+
license='MIT',
16+
install_requires=["requests", "uuid", "PyJWT"],
17+
packages=['setu'],
18+
zip_safe=False
19+
)

0 commit comments

Comments
 (0)