Skip to main content

DKIST library for generating quality report pdf

Project description

dkist-quality

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: dkist-quality-1.0.0rc1.tar.gz
  • Upload date:
  • Size: 116.9 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.0rc1.tar.gz
Algorithm Hash digest
SHA256 f0d50171e6bfcea8c3cf8156124817984facd9625659e10a4eb7886b0ec49c2c
MD5 d5781c9939b0603ad3db9f797e94234f
BLAKE2b-256 58a660d2a37b5cc6adfa1e1e15047f608badda7b3e7693402d9335b2591af868

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for dkist_quality-1.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 dfdb6aa1d7c3be16395d556db4e6be2e7327680c070bd2ecc6b56cd2e635ce35
MD5 b9df69007fb33dcc2f3492d404bdc336
BLAKE2b-256 b03207a72b8a8499a44e8cc89d476bf1e4b09838f0691d2ebf189164788411fe

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