Mangrove Surface SDK
Project description
===========================
Mangrove Surface Python SDK
===========================
.. image:: https://circleci.com/gh/mangroveai/mangrove-surface-python-sdk.svg?style=svg
:target: https://circleci.com/gh/mangroveai/mangrove-surface-python-sdk
.. image:: https://readthedocs.org/projects/mangrove-surface-python-sdk/badge/?version=stable
:target: https://mangrove-surface-python-sdk.readthedocs.io/en/latest/?badge=stable
:alt: Documentation Status
.. _documentation: http://mangrove-surface-python-sdk.readthedocs.io/
Documentation
-------------
A complete documentation is available there: documentation_
Installation
------------
Install the python SDK package:
.. code-block:: python
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:
.. code-block:: shell
$ export SURFACE_URL=http://your_mangrove.ai_url/api
$ export SURFACE_TOKEN='eyJ0eXAiOiJKV1QiLCJhbGciOiJ...'
.. warning:: Mangrove Surface URL have to end with ``/api``.
.. note:: The explicit configuration overrides the implicit one.
.. note:: Token can be provided by the administrator using GUI (see
documentation) or using the SDK (see
:meth:`mangrove.Surface._Admin.create_token`:)
Test your installation
----------------------
You can run tests with the following python lines:
- Test if it is properly installed:
.. code-block:: python
>>> import mangrove_surface
>>> mangrove_surface.__version__
'2.0.0'
The python SDK is properly connected to your Mangrove Surface:
.. code-block:: python
>>> from mangrove_surface import SurfaceClient
>>> # if environment variables are setup
>>> client = SurfaceClient()
>>> # otherwise
>>> # client = SurfaceClient(url="...", token="...")
>>> client.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:`surface`.
Support
-------
Please refer to :doc:`logger` section if you have any unexpected behavior using
the SDK.
Mangrove Surface Python SDK
===========================
.. image:: https://circleci.com/gh/mangroveai/mangrove-surface-python-sdk.svg?style=svg
:target: https://circleci.com/gh/mangroveai/mangrove-surface-python-sdk
.. image:: https://readthedocs.org/projects/mangrove-surface-python-sdk/badge/?version=stable
:target: https://mangrove-surface-python-sdk.readthedocs.io/en/latest/?badge=stable
:alt: Documentation Status
.. _documentation: http://mangrove-surface-python-sdk.readthedocs.io/
Documentation
-------------
A complete documentation is available there: documentation_
Installation
------------
Install the python SDK package:
.. code-block:: python
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:
.. code-block:: shell
$ export SURFACE_URL=http://your_mangrove.ai_url/api
$ export SURFACE_TOKEN='eyJ0eXAiOiJKV1QiLCJhbGciOiJ...'
.. warning:: Mangrove Surface URL have to end with ``/api``.
.. note:: The explicit configuration overrides the implicit one.
.. note:: Token can be provided by the administrator using GUI (see
documentation) or using the SDK (see
:meth:`mangrove.Surface._Admin.create_token`:)
Test your installation
----------------------
You can run tests with the following python lines:
- Test if it is properly installed:
.. code-block:: python
>>> import mangrove_surface
>>> mangrove_surface.__version__
'2.0.0'
The python SDK is properly connected to your Mangrove Surface:
.. code-block:: python
>>> from mangrove_surface import SurfaceClient
>>> # if environment variables are setup
>>> client = SurfaceClient()
>>> # otherwise
>>> # client = SurfaceClient(url="...", token="...")
>>> client.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:`surface`.
Support
-------
Please refer to :doc:`logger` section if you have any unexpected behavior using
the SDK.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mangrove-surface-sdk-1.0.0.tar.gz
(43.4 kB
view hashes)
Built Distribution
Close
Hashes for mangrove-surface-sdk-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7062c95a937c6c773d9fc502ae92f9a33260a1765b0b4f3803188abf1cfa6e6d |
|
MD5 | cafea65a4487baf8fd2327a28160cd3e |
|
BLAKE2b-256 | d3c52affe373a063eff9d33c392e91baa054071a2a98d49f254f36dd96a09e84 |
Close
Hashes for mangrove_surface_sdk-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 606aa510a770b4ba3c0b2ee89af69dc122cc1d8963d5a4f5fa89b990dcc31123 |
|
MD5 | e3dc07de917a53695e5d6bb292fbbe6b |
|
BLAKE2b-256 | ca0a7162aac06364b497768ffa7aab87443ff758e13008a96971af51f7150b8d |