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

To install the ESP python client, you can use pip:

.. code-block:: bash

  ~$ pip install espclient-<version>.tar.gz


If you have access to the L7 bitbucket repository, you can clone the repo and install like so:

.. code-block:: bash

    ~$ git clone git@bitbucket.org:lab7io/esp.git
    ~$ cd esp/client
    ~$ pip install .


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


Once you have the client installed, you can check if the installation was successful using the ``python -m esp status`` command:

.. code-block:: bash

    ~$ python -m esp -H 127.0.0.1 -P 8002 status

    Connecting to esp with following credentials:
       host: 127.0.0.1
       port: 8002
       email: admin@localhost
       cookies: None

    Connection established!


For information on how to use the client, see the `Usage <./usage.html>`_ section of the documentation.