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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: dkist_quality-1.1.1rc1.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.1rc1.tar.gz
Algorithm Hash digest
SHA256 a7af53e746dfde0859b75a639d2a3dde1e7fa6d3036fc216d62bc158ebac3e78
MD5 f0c6875ca0657851430a0c5370ff6bce
BLAKE2b-256 58c500b5636c8268c3901653ba7dbc5d7b98fd934ce20800ba7773c4dd9e07cf

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for dkist_quality-1.1.1rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 1293ca7c499e62e6e2f203df29eb5688db8eda9d83aed97dcab565101e7ac5c5
MD5 efad44cc704222885b9125c621d73e3c
BLAKE2b-256 eb98992a97b1c6ce200b581560987e9cbeb752d2c8fd3dc042aed5c7de95470e

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