.. highlight:: shell

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


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

To install luci, run this command in your terminal:

.. code-block:: console

    $ pip install luci

This is the preferred method to install luci, 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 luci can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/makkus/luci

Or download the `tarball`_:

.. code-block:: console

    $ curl  -OL https://github.com/makkus/luci/tarball/master

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/makkus/luci
.. _tarball: https://github.com/makkus/luci/tarball/master


Using inaugurate
----------------

`inaugurate <https://github.com/makkus/inaugurate>`_ is a generic bootstrap script that can, among other things, install python packages in it's own conda or virtualenv (in the users home directory):

Using conda
+++++++++++

.. code-block:: console

   $ curl https://inaugurate.sh | NO_EXEC=true bash -s -- luci

Using virtualenv
++++++++++++++++

.. code-block:: console

   $ curl https://inaugurate.sh | sudo NO_EXEC=true bash -s -- luci