Skip to content

Commit 389b9af

Browse files
Merge pull request #10 from ht-albert/master
Added requirements in readme file
2 parents ab2f8fb + eb1065a commit 389b9af

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
![pyversions](https://img.shields.io/pypi/pyversions/connect-sdk.svg) [![PyPi Status](https://img.shields.io/pypi/v/connect-sdk.svg)](https://pypi.org/project/connect-sdk/) [![codecov](https://codecov.io/gh/ingrammicro/connect-python-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/ingrammicro/connect-python-sdk) [![Build Status](https://travis-ci.org/ingrammicro/connect-python-sdk.svg?branch=master)](https://travis-ci.org/ingrammicro/connect-python-sdk)
44
### Getting Started
55
---
6+
Connect Python SDK allows an easy and fast integration with Connect fulfillment API. Thanks to it you can automate the fulfillment of orders generated by your products.
7+
8+
In order to use this library, please ensure that you have read first the documentation available on Connect knowladge base article located here, this one will provide you a great information on the rest api that this library implements.
69
### Class Features
710
---
811
This library may be consumed in your project in order to automate the fulfillment of requests, this class once imported into your project will allow you to:
@@ -26,13 +29,19 @@ Your code may use any scheduler to execute, from a simple cron to a cloud schedu
2629
```sh
2730
$ pip install connect-sdk
2831
```
32+
33+
### Requirements
34+
* Python 2.7+ or Python 3.4+
35+
* Requests (https://pypi.org/project/requests/)
36+
* Marshmallow (https://pypi.org/project/marshmallow/)
37+
2938
### Example
3039
```python
40+
from connect import FulfillmentAutomation
3141
from connect.config import Config
3242
from connect.logger import logger
3343
from connect.models import ActivationTemplateResponse, ActivationTileResponse
3444
from connect.models.exception import FulfillmentFail, FulfillmentInquire, Skip
35-
from connect import FulfillmentAutomation
3645

3746
Config(file='config.json')
3847

example/example.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1+
from connect import FulfillmentAutomation
12
from connect.config import Config
23
from connect.logger import logger
34
from connect.models import ActivationTemplateResponse, ActivationTileResponse
45
from connect.models.exception import FulfillmentFail, FulfillmentInquire, Skip
5-
from connect import FulfillmentAutomation
66

77
Config(file='config.json')
88

0 commit comments

Comments
 (0)