Mangrove Surface Python SDK

Documentation

A complete documentation is available there: documentation

Installation

Install the python SDK package:

pip install mangrove-surface

or using the git repository:

git clone https://github.com/mangroveai/mangrove-surface-python-sdk
python setup.py install

(optional) Setup your environment variables

You can used the SDK with an explicit configuration of url instance and token or you can provide them as environment variables: SURFACE_URL and SURFACE_TOKEN.

For example on unix-like system:

$ export SURFACE_URL=http://your_mangrove.ai_url/api
$ export SURFACE_TOKEN='eyJ0eXAiOiJKV1QiLCJhbGciOiJ...'

Test your installation

You can run tests with the following python lines:

• Test if it is properly installed:

>>> import mangrove-surface
>>> mangrove-surface.__version__
'2.0.0'

The python SDK is properly connected to your Mangrove Surface:

>>> from mangrove-surface import Mangrove-Surface
>>> # if environment variables are setup
>>> surface = Mangrove-Surface()
>>> # otherwise
>>> # surface = Mangrove-Surface(surface_url="...", surface_token="...")
>>> surface.admin.versions()
[
    {
        'name': 'atlas',
        'version': '1.0.0'
    }, {
        'name': 'license_authority',
        'version': u'1.5.0'
    }, {
        'name': 'dmgr',
        'version': '1.0.0'
    }, {
        'name': 'modeler',
        'version': '1.0.0'
    }, {
        'name': 'exporter',
        'version': '1.0.0'
    }, {
        'name': 'mangrove-surface-sdk',
        'version': '1.0.0'
    }
]

It is well configured! Congratulation!

Let's begin with :doc:`Mangrove Surface`.

Support

Please refer to :doc:`logger` section if you have any unexpected behavior using the SDK.