.. Azion API documentation master file, created by
   sphinx-quickstart on Mon May 21 00:26:00 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===============================================
azion-python: interacting with Azion's ReST API
===============================================

.. image:: https://travis-ci.org/mauricioabreu/azion-python.svg?branch=master
    :target: https://travis-ci.org/mauricioabreu/azion-python


.. image:: https://img.shields.io/github/license/mauricioabreu/azion-python.svg
    :alt: GitHub license
    :target: https://github.com/mauricioabreu/azion-python/blob/master/LICENSE


**azion-python** is a library to interact with `Azion's ReST API`.

.. note:: This client only supports Python 3. I recommend you to upgrade your systems to use Python 3.

-------------------

With this library you will be able to use the ReST API using a pythonic approach,
handling Python objects (models) instead of raw JSON responses.

.. code-block:: python

    from azion import authorize, login

    # Retrieve a new token
    auth = authorize('myemail@mail.com', 'mysecretpassword')

    # Login using the token
    azion = login(auth.token)

    # Retrieve a configuration
    configuration = azion.get_configuration(1028910)

    print(configuration.name)

You can checkout more examples throught the documentation.

.. toctree::
    :maxdepth: 2

    examples/configurations
    examples/purge

Installation
============

.. code-block:: console

    $ pipenv install azion-python

API
===

.. toctree::
    :maxdepth: 2

    api/index

Contributing
============

.. toctree::
    :maxdepth: 2

    contributing/testing

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`