summaryrefslogtreecommitdiff
path: root/docs/install.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain.pocentek@objectif-libre.com>2016-01-03 16:33:41 +0100
committerGauvain Pocentek <gauvain.pocentek@objectif-libre.com>2016-01-03 16:36:43 +0100
commit7523a612ace8bfa770737b5218ccc899f59f85df (patch)
tree3947a425a06252fdc52a60749632bd351d7f6fb8 /docs/install.rst
parent0ee53e0c5853c08b69d21ba6b89bd1bf8ee6bb18 (diff)
downloadgitlab-7523a612ace8bfa770737b5218ccc899f59f85df.tar.gz
Document installation using pip and git
Diffstat (limited to 'docs/install.rst')
-rw-r--r--docs/install.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/install.rst b/docs/install.rst
new file mode 100644
index 0000000..6abba3f
--- /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
+<https://github.com/gpocentek/python-gitlab>`__. 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