python-twitch |version|
=======================

.. warning::

        This documentation is currently a work in progress and is still rough
        around the edges. Not finding what you are looking for? Please open an
        issue describing your troubles on `python-twitch's github page`_!


**python-twitch** is a library designed for easy access to the twitch_ api's. It
is written in Python_ and enables you to access most of the functionality of the
official twitch-api documentation while also offering an interface towards their
hidden api and usher services.


Features
--------

python-twitch |version| currently supports:

* access to twitch api's
    + v3 api
    + hidden api
    + usher api
* translation of m3u8 playlists into more friendly json format
* tests!

Contents:
---------

.. toctree::
   :maxdepth: 2

   quickstart
   contribute

API Reference
-------------

.. toctree::
    :maxdepth: 2

    api

   
Indices and tables
------------------

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


.. Links

.. _twitch: http://www.twitch.tv/
.. _Python: http://www.python.org/
.. _`python-twitch's github page`: https://github.com/ingwinlu/python-twitch