diff options
| -rw-r--r-- | README.md | 22 | ||||
| -rw-r--r-- | docs/cli.rst | 4 |
2 files changed, 18 insertions, 8 deletions
@@ -6,25 +6,35 @@ It supports the v3 api of GitLab. A CLI tool is also provided (called **gitlab**). -## Requirements +## Installation + +### Requirements python-gitlab depends on: -* [python-requests](http://docs.python-requests.org/en/latest/). +* [python-requests](http://docs.python-requests.org/en/latest/) +* [six](https://pythonhosted.org/six/) + +### Install with pip + +````` +pip install python-gitlab +````` ## State -python-gitlab >= 0.3 is considered stable. +python-gitlab is considered stable. ## Bugs reports Please report bugs and feature requests at https://github.com/gpocentek/python-gitlab/issues -## ToDo +## Documentation + +Work In Progress: http://python-gitlab.readthedocs.org/en/latest/ -* Improve documentation -* Write unit tests +Patches are welcome! ## Code snippet diff --git a/docs/cli.rst b/docs/cli.rst index 91001d7..2c03901 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -1,4 +1,4 @@ -Commnad line use -================ +Command line usage +================== Document here how to use command line tool |