.. highlight:: shell

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

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

To install pyf.aggregator, run this command in your terminal:

.. code-block:: console

    $ pip install pyf.aggregator

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

If you don't have `pip <https://pip.pypa.io>`_ installed, this
`Python installation guide <https://docs.python-guide.org/starting/installation/>`_
can guide you through the process.

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

The sources for pyf.aggregator can be downloaded from the
`Github repo <https://github.com/collective/pyf.aggregator/>`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git@github.com:collective/pyf.aggregator.git

Or download the `tarball <https://github.com/collective/pyf.aggregator/tarball/master>`_:

.. code-block:: console

    $ curl  -OL https://github.com/collective/pyf.aggregator/tarball/master

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

.. code-block:: console

    $ pip install -e .[dev]