.. highlight:: shell

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


Fedora COPR Repositories
------------------------

The recommended way to install Folder Custodian is through the Fedora Copr repositories:

.. code-block:: console

    $ sudo dnf copr enable iolaum/fcust
    $ sudo dnf install fcust

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

Python Packaging Index
----------------------

Alternatively Folder Custodian can be installed as a python package:

.. code-block:: console

    $ pip install fcust

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 Folder Custodian can be downloaded from the `Github repo`_.

..
    # https://github.com/sphinx-doc/sphinx/issues/2096

For more information follow the :ref:`Contributing<contributing0>` page.


.. _Github repo: https://github.com/Iolaum/fcust