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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: dkist-quality-1.0.0rc4.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.0rc4.tar.gz
Algorithm Hash digest
SHA256 fbbfec9d184d0628f91ae2d70884d94e5956b98aab806e23c730ceb6f5389ba7
MD5 12454a66e0cf67e84cdc6636749f79b7
BLAKE2b-256 b0e5f700507a4420fa668879f8ebc005e577932253738665b9ed506e5346d76e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for dkist_quality-1.0.0rc4-py3-none-any.whl
Algorithm Hash digest
SHA256 f2c58f2fc79a9295eb59b4b357ec5a4e631a45075d33370b22589b28eda61bbf
MD5 5126f08af11f94a34f8d1752b07d619d
BLAKE2b-256 f0b909a566df997de46f6059d1d556d281a93a6addd0e75e435ea29732b20844

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