diff --git a/README.md b/README.md index ae0c11e..0968994 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ ![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) ### Getting Started --- +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. + +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. ### Class Features --- 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 ```sh $ pip install connect-sdk ``` + +### Requirements +* Python 2.7+ or Python 3.4+ +* Requests (https://pypi.org/project/requests/) +* Marshmallow (https://pypi.org/project/marshmallow/) + ### Example ```python +from connect import FulfillmentAutomation from connect.config import Config from connect.logger import logger from connect.models import ActivationTemplateResponse, ActivationTileResponse from connect.models.exception import FulfillmentFail, FulfillmentInquire, Skip -from connect import FulfillmentAutomation Config(file='config.json') diff --git a/example/example.py b/example/example.py index caf5c79..94f3348 100644 --- a/example/example.py +++ b/example/example.py @@ -1,8 +1,8 @@ +from connect import FulfillmentAutomation from connect.config import Config from connect.logger import logger from connect.models import ActivationTemplateResponse, ActivationTileResponse from connect.models.exception import FulfillmentFail, FulfillmentInquire, Skip -from connect import FulfillmentAutomation Config(file='config.json')