File: installation.rst

package info (click to toggle)
gerritlib 0.4.0%2Bgit20150319-2
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 160 kB
  • ctags: 66
  • sloc: python: 326; makefile: 128
file content (50 lines) | stat: -rw-r--r-- 825 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
:title: Installing

Installing
==========

The module is known to pip and Debian-based distributions as
``gerritlib``.

``pip``::

    pip install gerritlib

``easy_install``::

    easy_install gerritlib

The module has been packaged since Ubuntu Oneiric (11.10)::

    apt-get install gerritlib

And on Fedora 19 and later::

    yum install gerritlib

For development::

    python setup.py develop


Documentation
-------------

Documentation is included in the ``doc`` folder. To generate docs
locally execute the command::

    tox -e docs

The generated documentation is then available under
``doc/build/html/index.html``.

Unit Tests
----------

Unit tests are in the ``tests`` folder.
To run the unit tests, execute the command::

    tox -e py27

* Note: View ``tox.ini`` to run tests on other versions of Python.