.. runeq documentation master file, created by
   sphinx-quickstart on Thu Apr 30 14:03:43 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:mod:`runeq` - Rune Labs Python SDK
===================================

.. image:: https://img.shields.io/pypi/l/runeq
   :alt: PyPI - License
.. image:: https://img.shields.io/pypi/pyversions/runeq
   :alt: PyPI - Python Version
.. image:: https://img.shields.io/pypi/v/runeq
   :alt: PyPI
.. image:: https://readthedocs.org/projects/runeq/badge/?version=latest
   :target: https://runeq.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status
.. image:: https://circleci.com/gh/rune-labs/runeq-python.svg?style=shield
   :target: https://app.circleci.com/pipelines/gh/rune-labs/runeq-python
   :alt: CircleCI Status

Python SDK to query data from the `Rune Labs <https://runelabs.io/>`_ `API <https://docs.runelabs.io>`_

----------------------------------------------

.. toctree::
   :maxdepth: 2
   :caption: Contents:

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

Install using pip:

   >>> pip install runeq

Or directly from source:

   >>> python3 setup.py install


Documentation
-------------

.. toctree::
   :maxdepth: 3

   pages/quickstart
   pages/config
   pages/resources
   pages/stream
   pages/errors

Source
------

The source code is available on `Github <https://github.com/rune-labs/runeq-python>`_.

API documentation can be browsed at `<https://docs.runelabs.io>`_.

Indices and Tables
------------------

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