Metadata-Version: 2.1
Name: rt-api
Version: 1.1.1
Summary: Unofficial python client for the Rooster Teeth api
Home-page: https://github.com/NickMolloy/rt_api
Author: Nicholas Molloy
Author-email: nick.a.molloy@gmail.com
License: GPLv3
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Multimedia
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: requests (>=2.12.5)
Requires-Dist: m3u8 (>=0.3.1)
Requires-Dist: requests-oauthlib (>=0.7.0)

.. image:: https://travis-ci.org/NickMolloy/rt_api.svg?branch=master
    :target: https://travis-ci.org/NickMolloy/rt_api

.. image:: https://readthedocs.org/projects/rt-api/badge/?version=latest
    :target: http://rt-api.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://badge.fury.io/py/rt-api.svg
    :target: https://badge.fury.io/py/rt-api

======
rt_api
======

rt_api is a python client for the Rooster Teeth Api. It allows easy access to resources such as episodes, seasons, shows, and users.

It supports Python 2.7, 3.4-3.7, as well as PyPy.


.. _installation-guide:

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

To install `rt_api`, run:

.. code::

    pip install rt_api

Alternatively rt_api can be installed from source by cloning the repository
and running setuptools:

.. code::

    git clone https://github.com/NickMolloy/rt_api
    cd rt_api
    python setup.py install



Using `rt_api`
---------------

The main entry point for the library is the `Api` class.
Instantiating this class will give access to all of the API functionality.
For example:

.. code-block:: python

   from rt_api.api import Api

   api = Api()  # Instantiate api. Generates default access token.
   latest_episodes = api.episodes()  # Get an iterable of the latest episodes
   newest_episode = next(latest_episodes)
   print(newest_episode.title)  # Print out episode title
   show = newest_episode.show  # Get a reference to the show the episode is from
   print(show.name)  # Print out name of the show

If you want to be able to perform actions as a specific user, you must first
authenticate:

.. code-block:: python

   from rt_api.api import Api

   api = Api()
   api.authenticate("myUsername", "myPassword")  # Authenticate as myUsername

From this point, all actions performed will be done in the context of that user.
For instance, the current user is available through the ``me`` attribute of the api:

.. code-block:: python

    my_user = api.me  # Get the user object associated with the authenticated user
    my_user.queue  # Get the current user's episode watch list


For more information on the available actions, see the
`package documentation <https://rt-api.readthedocs.io/en/latest/rt_api.html>`_,
or some `examples <https://rt-api.readthedocs.io/en/latest/examples.html>`_.


