Metadata-Version: 1.1
Name: post-qa
Version: 1.3.0
Summary: Upload QA metrics for LSST Data Management.
Home-page: https://github.com/lsst-sqre/post-qa
Author: Jonathan Sick
Author-email: jsick@lsst.org
License: MIT
Description: .. image:: https://img.shields.io/pypi/v/post-qa.svg
        .. image:: https://img.shields.io/travis/lsst-sqre/post-qa.svg
        
        #######
        post-qa
        #######
        
        Upload QA measurements from tools like `validate_drp <https://github.com/lsst/validate_drp>`_ to the SQuaSH database and web app.
        ``post-qa`` is meant to run in a CI workflow, like LSST Data Management's Jenkins CI.
        
        Install
        =======
        
        ::
        
           pip install post-qa
        
        Command Line Interface
        ======================
        
        ::
        
           usage: post-qa [-h] --lsstsw LSSTSW_DIRNAME --qa-json QA_JSON_PATH --api-url
                          API_URL --api-user API_USER --api-password API_PASSWORD
                          [--metrics [ACCEPTED_METRICS [ACCEPTED_METRICS ...]]] [--test]
           
           Upload JSON from validate_drp to the SQuaSH API's
           job ingest endpoint, usually ``/api/jobs/``.
           
           This script is meant to be run from a Jenkins CI environment
           and uses the following environment variables:
           
           - ``BUILD_ID`` : ID in the ci system
           - ``BUILD_URL``: ci page with information about the build
           - ``PRODUCT``: the name of the product built, in this case 'validate_drp'
           - ``dataset``: the name of the dataset processed by validate_drp
           - ``label`` : the name of the platform where it runs
           
           
           optional arguments:
             -h, --help            show this help message and exit
             --lsstsw LSSTSW_DIRNAME
                                   Path of lsstsw directory
             --qa-json QA_JSON_PATH
                                   Filename of QA JSON output file
             --api-url API_URL     URL of SQuaSH API endpoint for job submission
             --api-user API_USER   Username for SQuaSH API
             --api-password API_PASSWORD
                                   Password for SQuaSH API
             --metrics [ACCEPTED_METRICS [ACCEPTED_METRICS ...]]
                                   List metric names to upload (e.g., --metrics AM1 PA1)
             --test                Print the shimmed JSON rather than uploading it
        
        Further Reading
        ===============
        
        - `SQR-008: SQUASH QA database <http://sqr-008.lsst.io>`_.
        - `SQR-009: SQUASH dashboard prototype <http://sqr-009.lsst.io>`_.
        
        License Info
        ============
        
        Copyright 2016 AURA/LSST
        
        MIT licensed open source.
        
Keywords: lsst
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
