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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: dkist-quality-1.0.0rc3.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.0rc3.tar.gz
Algorithm Hash digest
SHA256 3118bd8b76f4548eac791e9a292b921ca21d75acae4938524ec730fe4da59feb
MD5 cbaaae064d86b01bb71cfcb7cfa267fc
BLAKE2b-256 9784d1d40114dfbf6628a09cfe00f01a9d9f4ec4746c2149eb4cad429f55e71a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for dkist_quality-1.0.0rc3-py3-none-any.whl
Algorithm Hash digest
SHA256 198c1f8d87d7ce1118f96fe62a0339831b776bc60476d2ccfb273cb8deb917bd
MD5 3b96598854282eaa6066693fa52621f9
BLAKE2b-256 6f2356ba2d1719d1e2c8d7641204c9a36ab3da9a5052454553ab1787614ef7b1

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