x/stackalytics
Code Issues Proposed changes

Add Quickstart

Browse Source 
This patch adds the quickstart for operating Stackalytics more easily.

Change-Id: Ib3044adfbcd0e03f403b3686fca6ece9e3345b02
This commit is contained in:
Ken'ichi Ohmichi 2017-04-04 14:09:29 -07:00
parent 3f17971fe3
commit 94f654d4ae
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.rst
View File

@ -12,6 +12,40 @@ development activities and displays statistics on contribution. The features are
* Extract blueprint and bug ids from commit messages;
* Auto-update of database.
Quickstart
----------
To run Stackalytics, you first need to create two kind of configuration files.
The one is default_data.json which shows which sources(git repo, ml, etc.) need
to be analyzed. Another is stackalytics.conf which shows basic configuration like
HTTP listening host and port, etc. Stackalytics repository contains the default
files of these configuration under etc/ directory. It would be useful to copy and
change them as you like.
#. You need to install Stackalytics. This is done with pip after you check out
Stackalytics repository::
$ git clone http://git.openstack.org/openstack/stackalytics
$ cd stackalytics
$ sudo pip install -r requirements.txt
$ sudo python setup.py install
#. Install and run memcached DB::
$ sudo apt-get install -y memcached
$ memcached -u memcache -d
#. Analyze data which are specifed on default_data.json and store the data into memcached DB::
$ stackalytics-processor
#. Start HTTP server of Stackalytics::
$ stackalytics-dashboard
#. Users can access Stackalytics site on http://127.0.0.1:8080 as the default.
Project Info
-------------