DKIST library for generating quality report pdf
Project description
dkist-quality
Provides the ability to create a pdf quality report from structured quality data.
Sample Usage
from dkist_quality.report import format_report
def create_quality_report(report_data: dict | list[dict], dataset_id: str) -> bytes:
"""
Generate a quality report in pdf format.
:param report_data: Quality data for the dataset.
:param dataset_id: The dataset id.
:return: quality report in pdf format
"""
return format_report(report_data=report_data, dataset_id=dataset_id)
Developer Setup
pip install -e .[test]
pip install pre-commit
pre-commit install
License
This project is Copyright (c) NSO / AURA and licensed under the terms of the BSD 3-Clause license. This package is based upon the Openastronomy packaging guide which is licensed under the BSD 3-clause licence. See the licenses folder for more information.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
dkist_quality-1.0.2.tar.gz
(117.8 kB
view details)
Built Distribution
dkist_quality-1.0.2-py3-none-any.whl
(114.7 kB
view details)
File details
Details for the file dkist_quality-1.0.2.tar.gz
.
File metadata
- Download URL: dkist_quality-1.0.2.tar.gz
- Upload date:
- Size: 117.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b954b6e4d60608764dfb53601457842efd1391f22678a7d09bbdb2395ce7dbf |
|
MD5 | 9319afaf06e3aeaf3d5c7ead31fe313e |
|
BLAKE2b-256 | 2fc7370536b7401ff7dd8d95f8a6838ea3f2ca0760e95822b942650012518ac4 |
Provenance
File details
Details for the file dkist_quality-1.0.2-py3-none-any.whl
.
File metadata
- Download URL: dkist_quality-1.0.2-py3-none-any.whl
- Upload date:
- Size: 114.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d3283ab580b8183ab53b012c5da3b6df026612cb622122bc0b86a0fe27413cf |
|
MD5 | 4bd2a355e257de719a3755f01b120db6 |
|
BLAKE2b-256 | b71d2d2264681d24d547e851c57a8112cb2f7f566cdbe0de8333ca4b71f84c6d |