.. highlight:: shell

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


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

To install PyFreya, run this command in your terminal:

.. code-block:: console

    $ pip install pyfreya

This is the preferred method to install PyFreya, 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
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


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

The sources for PyFreya can be downloaded from the `Gitlab repo`_.

You can clone the public repository:

.. code-block:: console

    $ git clone https://gitlab.com/Yggdrasil27/pyfreya.git

.. code-block:: console

    $ python setup.py install


.. _Gitlab repo: https://gitlab.com/Yggdrasil27/pyfreya