diff options
| author | Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> | 2016-01-03 16:33:41 +0100 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> | 2016-01-03 16:36:43 +0100 |
| commit | 7523a612ace8bfa770737b5218ccc899f59f85df (patch) | |
| tree | 3947a425a06252fdc52a60749632bd351d7f6fb8 /docs | |
| parent | 0ee53e0c5853c08b69d21ba6b89bd1bf8ee6bb18 (diff) | |
| download | gitlab-7523a612ace8bfa770737b5218ccc899f59f85df.tar.gz | |
Document installation using pip and git
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/install.rst | 21 |
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst index ee9980e..8ddf933 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 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 |