qa4sm-autoreports

This packages contains the python code to programmatically create validation reports using QA4SM (automated validation reports).

This is a client application written in python that uses the QA4SM public API (access via the python API wrapper package)

Installation

In order to compile latex to pdf reports, you need to install texlive from https://tug.org/texlive/. This should enable the command line program pdflatex which is called from some python functions in this package.

sudo apt install texlive-full

Afterwards, you can install the package. This will also install the qa4sm-api package (which is the most important dependency.)

pip install qa4sm-autoreports

Then, you ideally set up the .qa4smapirc file as described here to enable access to different QA4SM instances via the API.

Alternatively, you can also set the QA4SM_INSTANCE and QA4SM_TOKEN environment variables, or pass the token and instance in your application code.

Development and testing

To install the package from source, with optional dependencies for testing (as required for developing the code), run

pip install -e .[testing]

Afterwards you can run pytest (integration tests are excluded)

pytest

To run the integration tests, which sets up a new validation report series and actually trigger validation runs on the test instance (which will take a few minutes), run

pytest -m "integration"

Main components

qa4sm_autoreports.run.ValidationRun

A class that sets up a local validation run directory, with a predefined validation configuration or an existing online validation run. Afterwards, it can be used to trigger a validation run online, check the run status of the run, or synchronize the validation results to the local folder.

qa4sm_autoreports.report.AutoReportCreator

A validation report combines multiple validation runs. It is a setup of multiple validation configurations (i.e., multiple runs required for a report to trigger online), download all results and collect various variables from different sources (processing date, status, errors, stats, etc.).

This also contains a method to compile a PDF using the downloaded and collected results for this report and a set up predefined latex templates. The latex template is filled with the data from the report, and the pdf is exported.

qa4sm_autoreports.series.AutoReportSeries

A validation report series combines multiple validation reports. It contains methods to track metrics across the report series and add/delete reports to/from the series.