Skip to content

Commit ecb27cb

Browse files
committed
Update README.md
1 parent e0bef7a commit ecb27cb

File tree

1 file changed

+35
-20
lines changed

1 file changed

+35
-20
lines changed

README.md

Lines changed: 35 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,45 @@
1-
# ecomm-wrapper-stripe
1+
# Minimal Pythin warpper for Stripe
22

3-
## Install package and run project
3+
This minimal library pulls the products from Stripe in `JSON` format.
44

5-
Create virtual envirnoment
6-
```
7-
virtualenv --python=python3 venv
8-
```
9-
activate virtual envirnoment
10-
```
11-
source venv/bin/activate (linux/mac)
12-
```
5+
<br />
6+
7+
## ✨ Quick Start
8+
9+
<br />
10+
11+
> 👉 **Step 1** - Create `.env` using provided `env.sample`
12+
13+
Add `.env` file in your projects root directory and add the following credentials
1314

14-
install stripe-wraper and other required packages
1515
```
16-
pip install getstripeproducts-0.0.1-py3-none-any.whl
17-
pip install python-dotenv
16+
STRIPE_API_KEY=<REAL_VALUE_HERE>
1817
```
1918

20-
create .env file and add STRIPE_API_KEY variable init.
19+
<br />
2120

22-
.env
23-
```
24-
STRIPE_API_KEY=stripeapikey
21+
> 👉 **Step 1** - Install `dependencies`
22+
23+
```bash
24+
$ python -m venv env
25+
$ source env/bin/activate
26+
$ pip install -r requirements.txt
2527
```
2628

27-
run script testproduct.py
28-
```
29-
python testproduct.py
29+
<br />
30+
31+
> 👉 Pull the products from Stripe dashboard
32+
33+
```bash
34+
$ python run.py
3035
```
36+
37+
The products are saved in `products.json`. Available props:
38+
39+
- `id`
40+
- `name`
41+
- `description`
42+
- `images`
43+
- `price`
44+
45+
<br />

0 commit comments

Comments
 (0)