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

Uploaded Source

Built Distribution

dkist_quality-1.0.4-py3-none-any.whl (113.2 kB view details)

Uploaded Python 3

File details

Details for the file dkist_quality-1.0.4.tar.gz.

File metadata

  • Download URL: dkist_quality-1.0.4.tar.gz
  • Upload date:
  • Size: 117.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.11.9

File hashes

Hashes for dkist_quality-1.0.4.tar.gz
Algorithm Hash digest
SHA256 b1c392034bbf79c7e1aa7a1aee39d371f4ca62d9661e37de0617538d8f9541f3
MD5 099c9045b08ad415fff1a8d9917bc52d
BLAKE2b-256 dda4f68b83dcae6bd63eac2e7df3a99611a98dfd4d2854039ac45569a19fe1aa

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for dkist_quality-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 28475114cd2e9099661434ee8952e376de4479d1a6ca49a7a8bf6bc71010e79c
MD5 b981780cfd0b86710b93113b78031bf7
BLAKE2b-256 fadb94942a81a0e5044a0ca2a6b8f8a7a51966c8922c39dd12644e8680a3d53b

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