INSTALLATION
**************


Installation from PyPI
----------------------

``py_lib`` can be installed normally from the Python Package Index. The
``py_lib`` script entry point will also be installed to your ``$PATH`` and
will be available for use from your terminal.

Note that you will need write access to your python packages folder. This
means you will have to install as root or with sudo on most linux distributions,
unless you are installing to a virtual environment you can write to.

.. code-block:: console

    $ sudo pip install py_lib

Installation from Sources
-------------------------

The sources can be downloaded from the project's
`github releases <https://github.com/amanabt/pylib/releases>`_.

.. code-block:: console

    $ wget https://github.com/amanabt/pylib/archive/v2.0.zip
    $ unzip v2.0.zip
    ...
    $ cd pylib-2.0
    $ sudo python setup.py install


Installation for Development
----------------------------

Installation from the repository is the most convenient installation method
if you intend to modify the code, either for your own use or to contribute to
``py_lib``.

.. code-block:: console

    $ git clone https://github.com/amanabt/pylib.git
    $ cd pylib
    $ sudo pip install -e .

*Link* : http://pypi.python.org/pypi/py_lib