Skip to main content

qa4sm-autoreports

CI PyPI Coverage Status Documentation

QA4SM Logo

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.

Metadata

Release files for qa4sm-autoreports 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qa4sm-autoreports 0.3.0
File Size Uploaded Provenance Actions
qa4sm_autoreports-0.3.0.tar.gz 8.6 MB Without provenance Details for qa4sm_autoreports-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for qa4sm-autoreports 0.3.0
File Interpreter ABI Platform Actions
qa4sm_autoreports-0.3.0-py3-none-any.whl Python 3 none any Details for qa4sm_autoreports-0.3.0-py3-none-any.whl

Total release size: 8.6 MB

Release files / qa4sm_autoreports-0.3.0.tar.gz

Download URL qa4sm_autoreports-0.3.0.tar.gz
Size 8.6 MB
Tags Source
SHA-256 checksum
How to use checksums
0a6275d1b11bb90a70e3332d69ce8643f5d68b8829c7655f58c5753962c83f45
BLAKE2b-256 checksum
How to use checksums
fdfde6501714e5da362566aa4c822f423969884d7a00f1215f49172c2724ea05
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / qa4sm_autoreports-0.3.0-py3-none-any.whl

Download URL qa4sm_autoreports-0.3.0-py3-none-any.whl
Size 36.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1e791b0e473ba7255d2d737f963acbc7ca314a93501ba2bbf873fca05a5fdf98
BLAKE2b-256 checksum
How to use checksums
3a795aeb493c609e8223e2ad3f11f479b53d0850d5368012f1ae4d4b11f38fec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for qa4sm-autoreports 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page