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

Uploaded Source

Built Distribution

dkist_quality-1.0.0rc2-py3-none-any.whl (114.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dkist-quality-1.0.0rc2.tar.gz
  • Upload date:
  • Size: 117.3 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.0rc2.tar.gz
Algorithm Hash digest
SHA256 7e6afdabc85f56b7c0659070d78f0a4cec7078e0f69c3153bd3de5124161fbfb
MD5 111c8bfcf59ff94071c1ce43d163fe17
BLAKE2b-256 f9c045a3c1c9ec6f462747aff79f1992a904e6eba85706415856782edd947df8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for dkist_quality-1.0.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 400fca55018d388cdf182c4012188bfd2e5ff7dc6fd7f6e5b56b9e82c16fe35f
MD5 73f9d6ddcd76a11976d3d9b25f7f3f61
BLAKE2b-256 f2e7fe12519ee5c5b4b8b52ae7f1d1952fbbc8aae435cd54756bb9cb824a4b70

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