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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: dkist_quality-1.1.1.tar.gz
  • Upload date:
  • Size: 117.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for dkist_quality-1.1.1.tar.gz
Algorithm Hash digest
SHA256 24420d184c549036090d22647227524a70c8e734800ca71fcf92b4678a1cdba0
MD5 d1fa81543379854450cfb32d537bd31a
BLAKE2b-256 368f8c54a94455e37c88d06d2443f306a5c428ad5c467367851d986c45d31053

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for dkist_quality-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 10eeafe014699f67d31b3463b1e8e0624c3054cedfd47ab557d8348195c555b3
MD5 460c42cbdce61299eb40bdd689af11f2
BLAKE2b-256 2b75a9fff5ea870004ba7e292c9e69d2b3845a317e88fc316714cd72dcff112f

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