semvec/pypi-packages huggingface dataset:
instantlab_apiclient 0.2.6
An API to the instantlab middleware
License: MIT
Keywords: instantlab api

Instantlab API Client
=====================

.. image:: http://instantlab.org/img/SkyLab_logo_small.png
    :alt: InstantLab Logo
    :align: right

Instantlab is a project that provides operating system experiments in the cloud.

.. image::
    https://img.shields.io/pypi/l/instantlab_apiclient.svg
    :target: https://pypi.python.org/pypi/instantlab_apiclient
    :alt: License
.. image::
    https://img.shields.io/pypi/pyversions/instantlab_apiclient.svg
    :target: https://pypi.python.org/pypi/instantlab_apiclient
    :alt: Python versions supported
.. image::
    https://readthedocs.org/projects/instantlab_apiclient/badge/?version=latest&style=flat
    :target: http://instantlab-apiclient.readthedocs.org
    :alt: Documentation
.. image::
    https://travis-ci.org/oaken-source/instantlab_apiclient.svg?branch=master
    :target: https://travis-ci.org/oaken-source/instantlab_apiclient
    :alt: Build status
.. image::
    http://codecov.io/github/oaken-source/instantlab_apiclient/instantlab_apiclient.svg
    :target: http://codecov.io/github/oaken-source/instantlab_apiclient
    :alt: Test Coverage

Instantlab_apiclient maps calls to the HTTP interface of the InstantLab Middleware to python functions. Results from the API are mapped to python objects and Errors in the API are raised as python exceptions.

Homepage: http://instantlab.org

Installation and Dependencies
-----------------------------

Install instantlab_apiclient with ``pip install instantlab_apiclient``. This will also install all dependencies.

Instantlab_apiclient works with **Python2.7+ and Python3.x**.

Example
-------

.. code-block:: python

    from instantlab_apiclient import InstantlabApi

    # instanciate API
    api = InstantlabApi(middleware_url, your_api_id, your_api_key)
    # fetch list of InfrastructureLayout
    infrastructure_layouts = api.list_infrastructure_layouts()
    # instanciate an Infrastructure from an InfrastructureLayout
    infrastructure = api.create_infrastructure(infrastructure_layouts[0].id)