Metadata-Version: 2.4
Name: atef
Version: 1.6.2
Summary: Python Automated Test Execution Framework
Author: SLAC National Accelerator Laboratory
License: Copyright (c) 2023, The Board of Trustees of the Leland Stanford Junior
        University, through SLAC National Accelerator Laboratory (subject to receipt
        of any required approvals from the U.S. Dept. of Energy). All rights reserved.
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        (1) Redistributions of source code must retain the above copyright notice,
            this list of conditions and the following disclaimer.
        
        (2) 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.
        
        (3) Neither the name of the Leland Stanford Junior University, SLAC National
            Accelerator Laboratory, U.S. Dept. of Energy 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 OWNER, THE UNITED STATES GOVERNMENT,
        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.
        
        You are under no obligation whatsoever to provide any bug fixes, patches, or
        upgrades to the features, functionality or performance of the source code
        ("Enhancements") to anyone; however, if you choose to make your Enhancements
        available either publicly, or directly to SLAC National Accelerator Laboratory,
        without imposing a separate written license agreement for such Enhancements,
        then you hereby grant the following license: a non-exclusive, royalty-free
        perpetual license to install, use, modify, prepare derivative works, incorporate
        into other computer software, distribute, and sublicense such Enhancements or
        derivative works thereof, in binary and source code form.
        
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: apischema
Requires-Dist: archapp>=1.1.0
Requires-Dist: bluesky
Requires-Dist: bluesky-queueserver>=0.0.19
Requires-Dist: bluesky-widgets
Requires-Dist: databroker<2.0.0a0
Requires-Dist: happi
Requires-Dist: ipython
Requires-Dist: matplotlib<=3.9.0
Requires-Dist: numpy
Requires-Dist: ophyd
Requires-Dist: pcdsutils>=0.14.1
Requires-Dist: pydm
Requires-Dist: PyQt5
Requires-Dist: pyyaml
Requires-Dist: qtpy
Requires-Dist: reportlab
Requires-Dist: rich
Requires-Dist: typhos
Requires-Dist: typing-extensions
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-timeout; extra == "test"
Requires-Dist: sphinx; extra == "test"
Requires-Dist: numpydoc; extra == "test"
Requires-Dist: sphinx-copybutton; extra == "test"
Requires-Dist: sphinx_rtd_theme; extra == "test"
Requires-Dist: doctr; extra == "test"
Requires-Dist: docs-versions-menu; extra == "test"
Requires-Dist: recommonmark; extra == "test"
Requires-Dist: pytest-asyncio; extra == "test"
Requires-Dist: pytest-qt; extra == "test"
Requires-Dist: pcdsdevices>=7.1.0; extra == "test"
Requires-Dist: sphinxcontrib-jquery; extra == "test"
Dynamic: license-file

===============================
atef
===============================

.. image:: https://img.shields.io/travis/pcdshub/atef.svg
        :target: https://travis-ci.org/pcdshub/atef

.. image:: https://img.shields.io/pypi/v/atef.svg
        :target: https://pypi.python.org/pypi/atef


ATEF: "Automated Test Execution Framework"

This is alpha-level software and does not include much in the way of working functionality just yet.

While the project has "automated" in its name, that is only one part of atef.
At this point - this is all subject to change - the project is broken up into several
different parts:

* Passive testing of control system devices/state
    * Fully-automated
    * Non-intrusive (will not move your motors)
    * Report generated
    * For daemon-backed passive tests, a control system-linked status report
* Active testing of control system devices
    * Guided, interactive checkout process with
    * Perhaps also fully automated versions of the above
    * Report generation
* General user-facing GUI (TUI)
    * Synoptic for launching tests ("device dashboard")
    * Command-line tools for doing the same

Some plans and ramblings are detailed in the discussions section for now:
https://github.com/pcdshub/atef/discussions
