.. _module-main:

===================
Module: __init__.py
===================

:Author:    Stefan Eletzhofer
:Date:      2012-05-17

Abstract
========

This is the main module.

Usage Example
=============

Getting the 'api' object
------------------------

To get the API use :py:func:`get_api` function::

    >>> from nexiles.toola.api import get_api
    >>> api = get_api("http://example.com", "fred", "kaputnik")

Getting a `resource` object
---------------------------

First get the `api`::

    >>> from nexiles.toola.api import get_api, get_resource
    >>> api = get_api("http://example.com", "fred", "kaputnik")

then the resource using the :py:func:`nexiles.tools.api.get_resource` function::

    >>> documents_resource = get_resource(api, "documents")

Module Documentation
====================

.. automodule:: nexiles.tools.api
   :members:

.. vim: set ft=rst tw=75 nocin nosi ai sw=4 ts=4 expandtab: