From 7523a612ace8bfa770737b5218ccc899f59f85df Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Sun, 3 Jan 2016 16:33:41 +0100 Subject: [PATCH] Document installation using pip and git --- docs/index.rst | 1 + docs/install.rst | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 docs/install.rst diff --git a/docs/index.rst b/docs/index.rst index ee9980e5c..8ddf9337b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,7 @@ Contents: .. toctree:: :maxdepth: 2 + install cli usage api/gitlab diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 000000000..6abba3f03 --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,21 @@ +############ +Installation +############ + +``python-gitlab`` is compatible with python 2 and 3. + +Use :command:`pip` to install the latest stable version of ``python-gitlab``: + +.. code-block:: console + + $ pip install --upgrade python-gitlab + +The current development version is available on `github +`__. Use :command:`git` and +:command:`pip` to install it: + +.. code-block:: console + + $ git clone https://github.com/gpocentek/python-gitlab + $ cd python-gitlab + $ python setup.py install