.. Star API documentation master file, created by
   sphinx-quickstart on Tue Nov 20 21:31:28 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Client Python Star API : Documentation
======================================

.. toctree::
   :maxdepth: 2

   howtouse
   starapi

La STAR (société qui gère les transports en commun de Rennes Métropole) fournit
des données sur son service de transport, dont des données temps réels.

Lors de l'ouverture de données temps réel en Open-Data, il était plus que temps
de se pencher dessus, et de proposer un client en python pour interroger l'API
Open-Data de la STAR.

Cette documentation propose de décrire le fonctionnement de ce client.

Amusez-vous bien, et bon voyage.

Licence et notes aux utilisateurs
---------------------------------

Ce client est développé sous licence LGPL, par un développeur du
Collectif Open-Data Rennes, association indépendante de Kéolis, de la STAR, et
de Rennes Métropole.

Ce n'est donc pas un client "officiel", mais nous espérons qu'il sera
satisfaisant.

Installation
------------

Après avoir téléchargé les sources du projet, l'installation se fait avec
setuptools, avec les droits administrateurs :::

    python setup.py install

Ceci doit installer le module :mod:`starapi` ainsi que sa dépendance
principale, le module `requests`.

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

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