Skip to main content

DKIST library for generating quality report pdf

Project description

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.

Project details


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.0.tar.gz (116.4 kB view details)

Uploaded Source

Built Distribution

dkist_quality-1.0.0-py3-none-any.whl (113.3 kB view details)

Uploaded Python 3

File details

Details for the file dkist-quality-1.0.0.tar.gz.

File metadata

  • Download URL: dkist-quality-1.0.0.tar.gz
  • Upload date:
  • Size: 116.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for dkist-quality-1.0.0.tar.gz
Algorithm Hash digest
SHA256 73d322765613c62d5048ac34a5b3209ebb430e9feeb291c8ef422bb470c7436f
MD5 752e54de3c067538e26b9f77f48e81bd
BLAKE2b-256 a444815523c91b02d4435cc163e6d7fab4d9c4c18b21f8adf470659ae8266cb6

See more details on using hashes here.

Provenance

File details

Details for the file dkist_quality-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dkist_quality-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ea9844932aa6efe5f6afd727acf8b78c90df632e24b912c7342186a751467fdf
MD5 6fedbca947c7ee9b041ee3e65091bfc9
BLAKE2b-256 82025bf8423dfb349a1899ff2518f8c1095655b220fbbb5f12d646c860f08150

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page