.. SPDX-FileCopyrightText: 2025 CERN <home.cern>
..
.. SPDX-License-Identifier: CC-BY-SA-4.0

pypts
=====

Introduction
------------

pypts is a hardware-oriented testing framework developed by BE-CEM-MTA.

Key Features:

*   **YAML-based Recipes:** Define test sequences, steps, parameters, and variables using structured YAML files.
*   **Modular Steps:** Supports various step types including Python function calls, sub-sequence execution, user interaction prompts, wait times, and indexed steps for running tasks multiple times with varying inputs.
*   **Reliable order execution:** Unlike ``pytest-order``, the reliably follows the specified order.
*   **Variable Scopes:** Manages global variables for the recipe and local variables within sequences.
*   **Threaded Execution:** Runs recipes in a separate thread using ``pts.run_pts``.
*   **Incremental Reporting:** Generates a detailed CSV report (``report.csv``) in real-time as steps complete.
*   **Contextual Reports:** Includes run context (Recipe Name, File Name, Serial Number) and step context (Sequence Name) in reports.
*   **HTML Reports:** Provides a utility to convert the CSV report into a styled HTML file (``report.html``) for easy viewing, similar to ``pytest-html``.
*   **Event System:** Uses queues for inter-thread communication and event reporting (e.g., step start/end).


Installation
------------

Using the `acc-py Python package index
<https://wikis.cern.ch/display/ACCPY/Getting+started+with+acc-python#Gettingstartedwithacc-python-OurPythonPackageRepositoryrepo>`_
``pts-framework`` can be pip installed with::

   pip install pts-framework


Documentation contents
----------------------

.. toctree::
    :maxdepth: 1
    :hidden:

    self

.. toctree::
    :caption: pypts
    :maxdepth: 1

    usage
    examples
    troubleshooting

.. toctree::
    :caption: Reference docs
    :maxdepth: 1

    api
    architecture
    recipe_language_architecture
    recipe_language_maintenance
    _generated/recipe_language_reference
    gui_architecture
    yaml_format
    instruments
    gui_event_handling
    report_generation
    dependency_license_analysis
    genindex