.. highlight:: shell

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


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

To install RBD iSCSI Client, run this command in your terminal:

.. code-block:: console

    $ pip install rbd-iscsi-client

This is the preferred method to install RBD iSCSI Client, 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 RBD iSCSI Client can be downloaded from the `git repo`_
hosted on opendev.org.

You can either clone the public repository:

.. code-block:: console

    $ git clone https://opendev.org/openstack/rbd-iscsi-client.git

Or download the `tarball`_:

.. code-block:: console

    $ curl  -OL https://opendev.org/openstack/rbd-iscsi-client/archive/master.tar.gz

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python setup.py install


.. _git repo: https://opendev.org/openstack/rbd-iscsi-client
.. _tarball: https://opendev.org/openstack/rbd-iscsi-client/archive/master.tar.gz