A tool to generate cached HTML pages with statistics about Fedora review tickets
Find a file
Mattia Verga d19afa1615 Fix for bugs in RELEASE_PENDING not fetched
Signed-off-by: Mattia Verga <mattia.verga@tiscali.it>
2024-07-31 08:01:26 +02:00
review_stats Fix for bugs in RELEASE_PENDING not fetched 2024-07-31 08:01:26 +02:00
.flake8 Flake8 style polishing 2020-11-16 18:23:24 +01:00
COPYING Add license file 2020-02-29 17:24:54 +01:00
Dockerfile add python3-setuptools for pkg_resources 2024-05-22 13:46:30 -07:00
MANIFEST.in Add example cron script 2020-02-16 11:22:01 +01:00
pyproject.toml Define BZ results limit to prevent bz default 2021-09-15 18:53:09 +02:00
README.rst Add a command to operate on stale review tickets 2020-06-02 17:08:20 +02:00
setup.py Fix missing static files to package 2024-05-24 11:42:18 +02:00

review_stats
============
A tool to generate cached HTML pages with statistics about Fedora review tickets.

Description
-----------
This tool is used by fedora-infrastructure to generate some HTML pages with useful statistics about new package review tickets opened in Red Hat Bugzilla.
It's also responsible for managing stale review tickets, asking for submitter or reviewer updates and
closing or resetting the ticket state when appropriate.

Usage
-----
.. code:: bash

   review-stats make-pages -d <OUTPUT_HTML_DIR>

`review_stats` requires a configuration file to be set up before usage. An example `review-stats.cfg` is provided by the package.

Config file parameters description
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**url**: URL of the xmlrpc Bugzilla server instance. Defaults to Red Hat Bugzilla server.

**username** / **password**: for authentication to the Bugzilla server.

**bugzilla_api_key**: alternative to username/password authentication.

**journal_level**: store run information to systemd journal with the desired level.

**mail_level**: send log messages of the desired level to a list of email addresses. Be aware these addresses will receive one email for each log message sent to the queue! Using a level lower than ERROR is discouraged.

**mail_server**: the SMTP server to use for sending emails with the format `server:port`.

**mail_username** / **mail_password**: for authentication to the SMTP server.

**mail_secure**: set to true if SSL authentication is needed.

**mail_from**: sender address.

**mail_to**: comma separated list of email addresses.

Base command parameters
^^^^^^^^^^^^^^^^^^^^^^^
**-c, --config FILENAME**: the config file to use. By default the script will automatically search for it in `/etc/`.

**-l, --enable-systemd-log**: enable logging to system's journal via systemd.

**-v, --verbose**: set console output to INFO level.

**-D, --debug**: set console output to DEBUG level.

make-pages parameters
^^^^^^^^^^^^^^^^^^^^^
**-t, --templatedir PATH**: a path to the directory where HTML templates are stored. By default the script will automatically search for them in the package install dir.

***-s, --staticfilesdir PATH**: a path to the directory where static files are stored. By default the script will automatically search for them in the package install dir.

**-d, --destination PATH [required]**: the path where generated HTML files should be copied.

work-on-bugs parameters
^^^^^^^^^^^^^^^^^^^^^^^
**-d, --dry-run**: do not really operate on bugs, but only output debug messages.