Metadata-Version: 2.1
Name: dkist-quality
Version: 1.0.0rc2
Summary: DKIST library for generating quality report pdf
Author-email: NSO / AURA <dkistdc@nso.edu>
License: Copyright (c) 2024, NSO / AURA
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without modification,
        are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright notice, this
          list of conditions and the following disclaimer in the documentation and/or
          other materials provided with the distribution.
        * Neither the name of the Astropy Team nor the names of its contributors may be
          used to endorse or promote products derived from this software without
          specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
        ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: repository, https://bitbucket.org/dkistdc/dkist-quality
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
Requires-Dist: reportlab ==4.1.0
Requires-Dist: matplotlib ==3.7.4
Requires-Dist: seaborn ==0.13.2
Requires-Dist: dacite ==1.8.1
Requires-Dist: natsort ==8.4.0
Requires-Dist: pydantic <2,>=1.10.14
Provides-Extra: test
Requires-Dist: tox >=4 ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: Pygments ; extra == 'test'
Requires-Dist: PyPDF4 ; extra == 'test'

dkist-quality
-------------

|codecov|

Provides the ability to create a pdf quality report from structured quality data.


Sample Usage
~~~~~~~~~~~~

.. code-block:: python

    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
~~~~~~~~~~~~~~~

.. code-block:: bash

    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 <https://github.com/OpenAstronomy/packaging-guide>`_
which is licensed under the BSD 3-clause licence. See the licenses folder for
more information.

.. |codecov| image:: https://codecov.io/bb/dkistdc/dkist_quality/branch/master/graph/badge.svg
   :target: https://codecov.io/bb/dkistdc/dkist-quality
