ciwatch/doc/source/installation.rst
Mikhail S Medvedev fb75343650 Apply openstack-dev cookiecutter template
CI Watch project started outside of OpenStack infrastructure.
This patch adds missing bits to enables infra testing, documentation
builds, and to make packaging easier if we'd like to do so.

Additional changes to accommodate the template:

 * ciwatch/__init__.py renamed to ciwatch/server.pp, and all related
   imports updated.
 * README.md converted into rst and split up into sections.

Partial-Bug: #1505834
Change-Id: I0aaabcfd1607609a337ce6ca2a71f9889b45de0a
2015-10-23 16:54:27 -05:00

505 B

Installation

At the command line:

$ pip install .

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv ciwatchenv
$ pip install .

Configuration is stored in the ci-watch.conf file. Importantly, you can specify a directory to store the third-party-ci.log file (data_dir) as well as the database to connect to. Look at ci-watch.conf.sample for an example.

Other settings should be self explanatory based on the provided configuration file.