{ "info": { "author": "Mangrove", "author_email": "contact@mangrove.ai", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3" ], "description": "===========================\nMangrove Surface Python SDK\n===========================\n\n.. image:: https://circleci.com/gh/mangroveai/mangrove-surface-python-sdk.svg?style=svg\n :target: https://circleci.com/gh/mangroveai/mangrove-surface-python-sdk\n\n.. image:: https://readthedocs.org/projects/mangrove-surface-python-sdk/badge/?version=stable\n :target: https://mangrove-surface-python-sdk.readthedocs.io/en/latest/?badge=stable\n :alt: Documentation Status\n\n.. _documentation: http://mangrove-surface-python-sdk.readthedocs.io/\n\nDocumentation\n-------------\n\nA complete documentation is available there: documentation_\n\nInstallation\n------------\n\nInstall the python SDK package:\n\n.. code-block:: python\n\n pip install mangrove-surface\n\nor using the git repository::\n\n git clone https://github.com/mangroveai/mangrove-surface-python-sdk\n python setup.py install\n\n(*optional*) Setup your environment variables\n---------------------------------------------\n\nYou can used the SDK with an explicit configuration of url instance and token\nor you can provide them as environment variables: ``SURFACE_URL`` and\n``SURFACE_TOKEN``.\n\nFor example on unix-like system:\n\n.. code-block:: shell\n\n $ export SURFACE_URL=http://your_mangrove.ai_url/api\n $ export SURFACE_TOKEN='eyJ0eXAiOiJKV1QiLCJhbGciOiJ...'\n\n.. warning:: Mangrove Surface URL have to end with ``/api``.\n\n.. note:: The explicit configuration overrides the implicit one.\n\n.. note:: Token can be provided by the administrator using GUI (see\n documentation) or using the SDK (see\n :meth:`mangrove.Surface._Admin.create_token`:)\n\n\nTest your installation\n----------------------\n\nYou can run tests with the following python lines:\n\n - Test if it is properly installed:\n\n.. code-block:: python\n\n >>> import mangrove_surface\n >>> mangrove_surface.__version__\n '2.0.0'\n\nThe python SDK is properly connected to your Mangrove Surface:\n\n.. code-block:: python\n\n >>> from mangrove_surface import SurfaceClient\n >>> # if environment variables are setup\n >>> client = SurfaceClient()\n >>> # otherwise\n >>> # client = SurfaceClient(url=\"...\", token=\"...\")\n >>> client.admin.versions()\n [\n {\n 'name': 'atlas',\n 'version': '1.0.0'\n }, {\n 'name': 'license_authority',\n 'version': u'1.5.0'\n }, {\n 'name': 'dmgr',\n 'version': '1.0.0'\n }, {\n 'name': 'modeler',\n 'version': '1.0.0'\n }, {\n 'name': 'exporter',\n 'version': '1.0.0'\n }, {\n 'name': 'mangrove-surface-sdk',\n 'version': '1.0.0'\n }\n ]\n\nIt is well configured! Congratulation!\n\nLet's begin with :doc:`surface`.\n\nSupport\n-------\n\nPlease refer to :doc:`logger` section if you have any unexpected behavior using\nthe SDK.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/mangroveai/mangrove-surface-python-sdk", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "mangrove-surface-sdk", "package_url": "https://pypi.org/project/mangrove-surface-sdk/", "platform": "", "project_url": "https://pypi.org/project/mangrove-surface-sdk/", "project_urls": { "Homepage": "https://github.com/mangroveai/mangrove-surface-python-sdk" }, "release_url": "https://pypi.org/project/mangrove-surface-sdk/1.0.0/", "requires_dist": [ "requests (>=2.12.3)", "requests-toolbelt (>=0.7.0)", "clint (>=0.5.1)", "humanize (>=0.5.1)", "funcsigs (>=1.0.2)", "boto3 (>=1.4.4)" ], "requires_python": "", "summary": "Mangrove Surface SDK", "version": "1.0.0" }, "last_serial": 3762389, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "e3dc07de917a53695e5d6bb292fbbe6b", "sha256": "606aa510a770b4ba3c0b2ee89af69dc122cc1d8963d5a4f5fa89b990dcc31123" }, "downloads": -1, "filename": "mangrove_surface_sdk-1.0.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "e3dc07de917a53695e5d6bb292fbbe6b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 37742, "upload_time": "2018-04-13T16:04:10", "url": "https://files.pythonhosted.org/packages/ca/0a/7162aac06364b497768ffa7aab87443ff758e13008a96971af51f7150b8d/mangrove_surface_sdk-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cafea65a4487baf8fd2327a28160cd3e", "sha256": "7062c95a937c6c773d9fc502ae92f9a33260a1765b0b4f3803188abf1cfa6e6d" }, "downloads": -1, "filename": "mangrove-surface-sdk-1.0.0.tar.gz", "has_sig": true, "md5_digest": "cafea65a4487baf8fd2327a28160cd3e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 43425, "upload_time": "2018-04-13T16:04:11", "url": "https://files.pythonhosted.org/packages/d3/c5/2affe373a063eff9d33c392e91baa054071a2a98d49f254f36dd96a09e84/mangrove-surface-sdk-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e3dc07de917a53695e5d6bb292fbbe6b", "sha256": "606aa510a770b4ba3c0b2ee89af69dc122cc1d8963d5a4f5fa89b990dcc31123" }, "downloads": -1, "filename": "mangrove_surface_sdk-1.0.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "e3dc07de917a53695e5d6bb292fbbe6b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 37742, "upload_time": "2018-04-13T16:04:10", "url": "https://files.pythonhosted.org/packages/ca/0a/7162aac06364b497768ffa7aab87443ff758e13008a96971af51f7150b8d/mangrove_surface_sdk-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cafea65a4487baf8fd2327a28160cd3e", "sha256": "7062c95a937c6c773d9fc502ae92f9a33260a1765b0b4f3803188abf1cfa6e6d" }, "downloads": -1, "filename": "mangrove-surface-sdk-1.0.0.tar.gz", "has_sig": true, "md5_digest": "cafea65a4487baf8fd2327a28160cd3e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 43425, "upload_time": "2018-04-13T16:04:11", "url": "https://files.pythonhosted.org/packages/d3/c5/2affe373a063eff9d33c392e91baa054071a2a98d49f254f36dd96a09e84/mangrove-surface-sdk-1.0.0.tar.gz" } ] }