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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dkist_quality-1.1.0.tar.gz
Algorithm Hash digest
SHA256 65ce2ddf179b59f7e65cf55e50afeb6f4f64ee2e75d1131babd8608e9a7450a9
MD5 03c662e22928a5f4e26a07f109737643
BLAKE2b-256 3a6da85c81177317de0d1e75f44905304f8bcae61997f66b6914f262005c2129

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for dkist_quality-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 271dff09229338413a455cbcc256fe873f7726958757bd82abfc7a861fb528d9
MD5 843211099cae4779f9566b7c2575e829
BLAKE2b-256 48e5ca9f2f5f92c260ffb2c4c316f9a04cfda9895ae9d573f1c570b369726fdb

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