Skip to content

Commit 86e9331

Browse files
committed
Release v0.0.2 - DOCS improvements
1 parent 0a7e26b commit 86e9331

File tree

4 files changed

+40
-5
lines changed

4 files changed

+40
-5
lines changed

CHANGELOG.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Change Log
22

3-
## [0.0.1] 2022-10-18
3+
## [0.0.2] 2022-10-18
4+
### Improvements
5+
6+
- DOCS update
7+
- Code changes (minor)
8+
9+
## [0.0.2] 2022-10-18
410
### Initial Version
511

612
- The start of the project is tracked

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,41 @@
11
# Simple Python Wrapper for Stripe
22

3-
This minimal library pulls the products from Stripe in [JSON format](./products.json) using `STRIPE_API_KEY` as input, loaded from environment.
3+
This minimal library pulls the products from Stripe in [JSON format](https://github.com/app-generator/ecomm-wrapper-stripe/blob/main/products.json) using `STRIPE_API_KEY` as input, loaded from environment.
44

55
<br />
66

77
## Quick Start
88

99
<br />
1010

11+
> **Install the package** via `PIP`
12+
13+
```bash
14+
$ pip install python-stripe
15+
```
16+
17+
<br />
18+
19+
> **Usage in code**
20+
21+
```python
22+
23+
from stripe_python import get_products
24+
25+
STRIPE_KEY = 'YOUR_key_here' # mandatory parameter
26+
OUTPUT_FILE = 'products.json' # optional
27+
28+
get_products( STRIPE_KEY, OUTPUT_FILE )
29+
```
30+
31+
All products associated with the account are pulled in `products.json`.
32+
33+
<br />
34+
35+
## Standalone Execution
36+
37+
<br />
38+
1139
> **Step 1** - Create `.env` using provided `env.sample`
1240
1341
Add `.env` file in your projects root directory and add the following credentials
@@ -52,4 +80,4 @@ The products are saved in `products.json`. Available props:
5280
<br />
5381

5482
---
55-
**Python Warpper for Stripe** - Free library provided by [AppSeed](https://appseed.us).
83+
**Simple Python Wrapper for Stripe** - Free library provided by [AppSeed](https://appseed.us).

run.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@
1313
if __name__ == "__main__":
1414

1515
STRIPE_API_KEY = os.getenv('STRIPE_API_KEY', None)
16+
OUTPUT_FILE = 'products.json'
1617

1718
if STRIPE_API_KEY:
18-
get_products( STRIPE_API_KEY )
19+
get_products( STRIPE_API_KEY, OUTPUT_FILE )
1920
else:
2021
print( 'Err: STRIPE_API_KEY not provided in ENV' )

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
setup(
1010
name='python-stripe',
11-
version='0.0.1',
11+
version='0.0.2',
1212
zip_safe=False,
1313
packages=find_packages(),
1414
include_package_data=True,

0 commit comments

Comments
 (0)