Quantopian Tools Documentation
==============================

.. important:: This project is not supported nor endorsed by `Quantopian <https://www.quantopian.com>`__.

|build| |docs| |pypi| |downloads| |github_release| |requirements| |coverage| |issues| |license|


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

This project is alpha and is actively being developed.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


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

.. code:: bash

    pip install quantopian-tools


Or to manually install, execute the following commands:


.. code:: bash

    git clone https://github.com/Gitlitio/quantopian-tools.git
    cd quantopian-tools/
    python setup.py install

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


Usage
-----

For full API usage documentation, refer to the `API <api.html>`__

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


Changelog
---------

See the change log located in our `source repo <https://github.com/Gitlitio/quantopian-tools/blob/master/CHANGELOG.md>`__

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


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

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

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


Site Map
--------
.. toctree::

    api


.. |build| image:: https://img.shields.io/travis/Gitlitio/quantopian-tools.svg
    :alt: Build Status
    :target: https://travis-ci.org/Gitlitio/quantopian-tools

.. |docs| image:: https://readthedocs.org/projects/quantopian-tools/badge/?version=latest
    :alt: Documentation Status
    :target: http://quantopian-tools.readthedocs.io/en/latest/

.. |pypi| image:: https://img.shields.io/pypi/v/quantopian-tools.svg
    :alt: PyPi Version
    :target: https://pypi.python.org/pypi/quantopian-tools/

.. |requirements| image:: https://img.shields.io/requires/github/Gitlitio/quantopian-tools.svg
    :alt: Requires.io
    :target: https://requires.io/github/Gitlitio/quantopian-tools/requirements/?branch=master

.. |coverage| image:: https://img.shields.io/codecov/c/github/Gitlitio/quantopian-tools.svg
    :alt: Codecov.io
    :target: https://codecov.io/gh/Gitlitio/quantopian-tools

.. |github_release| image:: https://img.shields.io/github/release/Gitlitio/quantopian-tools.svg
    :alt: Github Releases
    :target: https://github.com/Gitlitio/quantopian-tools/releases

.. |issues| image:: https://img.shields.io/github/issues/Gitlitio/quantopian-tools.svg
    :alt: Github Issues
    :target: https://github.com/Gitlitio/quantopian-tools/issues

.. |license| image:: https://img.shields.io/github/license/Gitlitio/quantopian-tools.svg
    :alt: License
    :target: https://github.com/Gitlitio/quantopian-tools/blob/master/LICENSE

.. |downloads| image:: https://img.shields.io/pypi/dm/quantopian-tools.svg
    :alt: PyPi Downloads
    :target: https://pypi.python.org/pypi/quantopian-tools/