openstack/reviewday
Code Issues Proposed changes

Update README.md.

Browse Source
This commit is contained in:
Dan Prince 2011-11-21 14:51:14 -05:00
parent e1a6f701fb
commit 8419c3b8fd
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -2,7 +2,7 @@
HTML report generator for OpenStack code reviews. Launchpad meets SmokeStack and Gerrit.
Based on and inspired by 'reviewlist' by Thierry Carez.
Inspired by 'reviewlist' scripts written by Thierry Carez.
## Description
@ -14,19 +14,21 @@ HTML report generator which creates a prioritized review list w/ function test r
## Installation
Install directly from pip (requires launchpadlib and cheetah):
1. Git clone the project.
2. Install Python libraries for launchpadlib and cheetah.
3. Setup your ssh credentials to work w/ Gerrit. See http://wiki.openstack.org/GerritWorkflow for details.
pip install reviewday
```bash
$ cat ~/.ssh/config
Host review
Hostname review.openstack.org
Port 29418
User dan-prince
```
You'll also need a working gerrit setup: http://wiki.openstack.org/GerritWorkflow
Specifically you'll need to be able to run gerrit command line queries.
## Execution
reviewday
An output directory called 'out_report' is generated in your working directory.
## Execution (Development)
PYTHONPATH=$PWD ./bin/reviewday
An output directory called 'out_report' is generated in the current directory.