Toolserver:Report tool

For users
The reports tool is a way to provide commonly used database queries in a regularly updated, easy-to-use form. It is a companion to the SQL Query service. If you would like a new query added, open a request in JIRA (in the 'Reports' component), describing what you want the query to do. If you can provide the SQL as well, that's helpful, but not a requirement.

For developers
This section describes how to develop the reports tool.

Generally, you should use your own copy of the tool for development. Check out the source from https://svn.toolserver.org/svnroot/river/reports/trunk. Copy reports.cfg.example to $HOME/.reports.cfg and edit it as appropriate. Run ./deploy from the source directory to deploy the application. Note: since it's FastCGI, if you deploy a new version, you should kill any existing processes so your changes are visible. (Ideally, this would be done automatically...)

Once you've committed changes and you want to deploy them, become the reptest user on stable. The source is in $HOME/src/. Run 'svn up', then ./deploy. Make sure the test version at http://stable.toolserver.org/reptest/ works. Then do the same thing, except as the reports user, to put your changes live.

NOTE: Do not commit as the reports or reptest users, because svn will save your password in the shared home directory.

(NB: there is no live version yet, just the reptest version.)

Rules for committing
REPORTS-1 When the user clicks quux, their computer explodes REPORTS-37 Need more mice to power slow queries REPORTS-37 Need more mice to power slow queries (fixed OutOfCheeseError caused by typo) REPORTS-1 When the user clicks quux, their computer explodes (fix indentation in python/DontExplode.py) and: REPORTS-1 When the user clicks quux, their computer explodes Here, the second commit contains the actual change.
 * All commits (except i18n changes) must have a JIRA issue associated. This includes minor commits.  If an i18n commit already has a JIRA issue, e.g. it was provided by a non-committer, use that issue and follow the process described here.
 * Make sure to assign the issue to yourself before you start working on it (or at the very least, before you commit)
 * The purpose of the commit should be described in the issue, not the commit message. Format the commit " ".  (If the issue title is misleading, change it, then commit.)  For example:
 * All commits must be tested, even minor ones.
 * If you make a mistake during a commit and need to fix it, use the same issue key as the original commit, and append the fix in brackets:
 * If you want to make other changes along with a commit (for example, commenting unrelated pieces of code, or reformatting a file), make two commits. One should contain only the change, the second should contain only the unrelated changes.  For example,

For translators
Follow the instructions above to check out the svn repository. i18n files are in i18n/*.msgs. Just copy en.msgs to .msgs, translate it, and send the result in a bug report to https://jira.toolserver.org/browse/REPORTS.

Note: as the tool is still very much in development, messages are likely to change frequently. If you plan to translate the tool, you should probably request commit access instead of opening a bug for each change.