.. highlight:: shell

============
Installation
============


Stable release
--------------

To install StreamStats, run this command in your terminal:

.. code-block:: console

    $ pip install streamstats

This is the preferred method to install StreamStats, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io/en/stable/
.. _Python installation guide: https://docs.python-guide.org/starting/installation/


From sources
------------

The sources for StreamStats can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/earthlab/streamstats

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python setup.py install


.. _Github repo: https://github.com/earthlab/streamstats
.. _tarball: https://codeload.github.com/earthlab/streamstats/legacy.tar.gz/master