Welcome to Syncurity SDK’s documentation!¶

irflow-sdk-python¶

A python client for Syncurity IR-Flow REST API¶

logger.info: Python2 support will be removed at the beginning of January 2020.

Documentation¶

View our documentation here

API Documentation¶

See the API functions here

Installation To Use in Production¶

pip install irflow_client

Upgrade¶

pip install irflow_client --upgrade

Build from source / install extra packages¶

Clone the repo: git clone git@github.com:Syncurity/irflow-sdk-python.git

For running tests:

1. Clone the repo:

git clone git@github.com:Syncurity/irflow-sdk-python.git

2. Install all requirements:

cd <project directory>
pip install .
pip install -r requirements-dev.txt

3. Run tests
pytest

4. Run tests with coverage
# With Coverage
cd tests
py.test --cov-report xml --cov-config .coveragerc --cov ../

Contribute¶

Pull requests are always appreciated

Support¶

Please open an issue in github

Examples¶

To get started with examples, read the examples README. It includes two sample python scripts that use the irflow_client.