Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 3.44 KB

README.md

File metadata and controls

78 lines (52 loc) · 3.44 KB
Raw

Connect Python SDK

pyversions PyPi Status codecov Build Status PyPI status Quality Gate Status

NOTE: We strongly recommend to use the connect-openapi-client with python instead of this SDK. All new functionalities are only added to python openapi client.

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.

Please check the documentation available here, which contains information on how to install and use the library, and a complete API reference guide.

Main 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:

  • Communicate with Connect using your API credentials.
  • List all requests, and even filter them:
    • For a specific product.
    • For a specific status.
    • For a specific asset.
    • Etc.
  • Process each request and obtain full details of the request.
  • Modify the activation parameters of each request in order to:
    • Inquiry for changes
    • Store information into the fulfillment request
  • Change the status of the requests from its initial pending state to either inquiring, failed or approved.
  • Generate and upload usage files to report usage for active contracts and listings.
  • Process usage file status changes.
  • Work with Notes for requests.
  • Generate logs.
  • Collect debug logs in case of failure.

Your code may use any scheduler to execute, from a simple cron to a cloud scheduler like the ones available in Azure, Google, Amazon or other cloud platforms.

Installation

$ pip install connect-sdk

Requirements

Contribute

If you want to contribute to the connect-python-sdk development feel free to open issues or fork the github repository and submit your pull request.

Development

Getting started

Assuming that you have python and virtualenv installed, and forked the connect-python-sdk repository, set up your environment and install the required dependencies like this:

$ git clone https://github.com/{your_github_account}/connect-python-sdk.git
$ cd connect-python-sdk
$ virtualenv venv
$ . venv/bin/activate
$ pip install -r requirements/test.txt

Running tests

The connect-python-sdk uses pytest for unit testing.

To run the entire tests suite execute:

$ pytest

License

The connect-python-sdk is released under the Apache License, Version 2.0.