8000 Rewrite the README · HardHero/python-gitlab@3e8cf4e · GitHub
[go: up one dir, main page]

Skip to content

Commit 3e8cf4e

Browse files
author
Gauvain Pocentek
committed
Rewrite the README
And link to the docs on RTD.
1 parent ca44878 commit 3e
10000
8cf4e

File tree

3 files changed

+38
-170
lines changed

3 files changed

+38
-170
lines changed

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
include README.md COPYING AUTHORS ChangeLog requirements.txt test-requirements.txt
1+
include COPYING AUTHORS ChangeLog requirements.txt test-requirements.txt
22
include tox.ini .testr.conf
33
recursive-include tools *

README.md

Lines changed: 0 additions & 169 deletions
This file was deleted.

README.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Python GitLab
2+
=============
3+
4+
``python-gitlab`` is a Python package providing access to the GitLab server API.
5+
6+
It supports the v3 api of GitLab, and provides a CLI tool (``gitlab``).
7+
8+
Installation
9+
============
10+
11+
Requirements
12+
------------
13+
14+
python-gitlab depends on:
15+
16+
* `python-requests <http://docs.python-requests.org/en/latest/>`_
17+
* `six <https://pythonhosted.org/six/>`_
18+
19+
Install with pip
20+
----------------
21+
22+
.. code-block:: console
23+
24+
pip install python-gitlab
25+
26+
Bug reports
27+
===========
28+
29+
Please report bugs and feature requests at
30+
https://github.com/gpocentek/python-gitlab/issues.
31+
32+
33+
Documentation
34+
=============
35+
36+
The documentation for CLI and API is available on `readthedocs
37+
<http://python-gitlab.readthedocs.org/en/stable/>`_.

0 commit comments

Comments
 (0)
0