Skip to content

Commit

Permalink
Release v0.0.2 - DOCS improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
app-generator committed Oct 18, 2022
1 parent 0a7e26b commit 86e9331
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 5 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Change Log

## [0.0.1] 2022-10-18
## [0.0.2] 2022-10-18
### Improvements

- DOCS update
- Code changes (minor)

## [0.0.2] 2022-10-18
### Initial Version

- The start of the project is tracked
Expand Down
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,41 @@
# Simple Python Wrapper for Stripe

This minimal library pulls the products from Stripe in [JSON format](./products.json) using `STRIPE_API_KEY` as input, loaded from environment.
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.

<br />

## Quick Start

<br />

> **Install the package** via `PIP`
```bash
$ pip install python-stripe
```

<br />

> **Usage in code**
```python

from stripe_python import get_products

STRIPE_KEY = 'YOUR_key_here' # mandatory parameter
OUTPUT_FILE = 'products.json' # optional

get_products( STRIPE_KEY, OUTPUT_FILE )
```

All products associated with the account are pulled in `products.json`.

<br />

## Standalone Execution

<br />

> **Step 1** - Create `.env` using provided `env.sample`
Add `.env` file in your projects root directory and add the following credentials
Expand Down Expand Up @@ -52,4 +80,4 @@ The products are saved in `products.json`. Available props:
<br />

---
**Python Warpper for Stripe** - Free library provided by [AppSeed](https://appseed.us).
**Simple Python Wrapper for Stripe** - Free library provided by [AppSeed](https://appseed.us).
3 changes: 2 additions & 1 deletion run.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
if __name__ == "__main__":

STRIPE_API_KEY = os.getenv('STRIPE_API_KEY', None)
OUTPUT_FILE = 'products.json'

if STRIPE_API_KEY:
get_products( STRIPE_API_KEY )
get_products( STRIPE_API_KEY, OUTPUT_FILE )
else:
print( 'Err: STRIPE_API_KEY not provided in ENV' )
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

setup(
name='python-stripe',
version='0.0.1',
version='0.0.2',
zip_safe=False,
packages=find_packages(),
include_package_data=True,
Expand Down

0 comments on commit 86e9331

Please sign in to comment.