====================
Python API reference
====================

This page describes the methods and properties available in the :class:`~hostedpi.picloud.PiCloud`
and :class:`~hostedpi.pi.Pi` classes and are intended as a useful reference to the functionality
provided.

The way to use the module is to import the :class:`~hostedpi.picloud.PiCloud` class, which will
use environment variables to authenticate with the API. This will allow you to provision new Pi
servers with the :meth:`~hostedpi.picloud.PiCloud.create_pi` method or access existing servers
from the :attr:`~hostedpi.picloud.PiCloud.pis` property.

Once you have a connected :class:`~hostedpi.picloud.PiCloud` instance and access to newly or
previously created :class:`~hostedpi.pi.Pi` instances, the following API documentation should prove
useful to show what you can do with the API via the *hostedpi* module.

For example usage, see :doc:`../usage`.

Contents
========

.. toctree::
   :maxdepth: 1

   picloud
   pi
   models
   exceptions
   auth