Skip to main content

dkist-quality

codecov

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.

Metadata

Release files for dkist-quality 2.0.1

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

Source distribution (sdist)

Source distribution for dkist-quality 2.0.1
File Size Uploaded
dkist_quality-2.0.1.tar.gz 121.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for dkist-quality 2.0.1
File Interpreter ABI Platform
dkist_quality-2.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 238.1 kB

Release files / dkist_quality-2.0.1.tar.gz

Download URL dkist_quality-2.0.1.tar.gz
Size 121.0 kB
Tags Source
SHA-256 checksum
How to use checksums
fca16ef43e7387377bd97299d272a713b4865a04c72acdc5ad9614495e7d5e8d
BLAKE2b-256 checksum
How to use checksums
b0a240e03e115efd31159b2551001b8c6dc93355c4bb8410a4e42095d7dcb776
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14

Release files / dkist_quality-2.0.1-py3-none-any.whl

Download URL dkist_quality-2.0.1-py3-none-any.whl
Size 117.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bc09d9a0f3a04bb8792de18f88c2347756dfad24a2dbec4c715f0aad0e325bc6
BLAKE2b-256 checksum
How to use checksums
62293ba9fd835da5f8ae0bd610f19d619fc9e03a50fcc8b8517f70a9e7cd795a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.14
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