pts-framework 0.6.1__tar.gz

pts_framework-0.6.1/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: pts-framework
+Version: 0.6.1
+Summary: Hardware-oriented testing framework developed by BE-CEM-MTA
+Author-email: Odd Oyvind Andreassen <odd.oyvind.andreassen@cern.ch>, Bartlomiej Banas <Bartlomiej.Banas@cern.ch>, Oliver Damborg <odamborg@cern.ch>, Alvaro Martinez Landete <alvaro.martinez.landete@cern.ch>
+License-Expression: LGPL-2.1-or-later
+Project-URL: Homepage, https://github.com/CERN/pts-framework
+Project-URL: Repository, https://github.com/CERN/pts-framework
+Project-URL: Changelog, https://github.com/CERN/pts-framework/blob/master/CHANGELOG.md
+Keywords: testing,hardware,instrumentation,cern
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: hightime==0.2.2
+Requires-Dist: matplotlib
+Requires-Dist: nidmm==1.4.8
+Requires-Dist: numpy
+Requires-Dist: PySide6==6.9.1
+Requires-Dist: PyYAML==6.0.2
+Requires-Dist: ruamel.yaml
+Requires-Dist: pymeasure==0.15.0
+Requires-Dist: pyserial
+Requires-Dist: paramiko
+Requires-Dist: pydantic<3,>=2.13
+Requires-Dist: pyvisa
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-qt; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-timeout; extra == "test"
+Provides-Extra: doc
+Requires-Dist: Sphinx; extra == "doc"
+Provides-Extra: dev
+Requires-Dist: pts-framework[doc,test]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+
+<!--
+SPDX-FileCopyrightText: 2025 CERN <home.cern>
+
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
+# pypts
+
+![pypts quick run](images/pypts_quick_run.gif)
+
+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).
+
+For full documentation, please visit [PTS Framework Documentation](https://acc-py.web.cern.ch/gitlab/pts/framework/pypts/docs/stable/).
+
+=======
+
+## Continuous integration and releases
+
+The project is tested in a disposable Python 3.13 Docker image. To reproduce the
+GitHub CI build locally, run:
+
+```sh
+docker build --build-arg SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PTS_FRAMEWORK=0+local -t pts-framework-ci .
+docker run --rm pts-framework-ci
+```
+
+Creating a protected `vX.Y.Z` tag runs the same tests, builds the wheel and source
+distribution, and publishes them to TestPyPI. Verify the TestPyPI package in a clean
+environment before approving the `pypi` GitHub Environment:
+
+```sh
+python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pts-framework==X.Y.Z
+```
+
+Approval publishes the same distributions to PyPI. GitHub retains the release
+artifact for 30 days; PyPI is the permanent package source. See
+[release configuration](.github/RELEASE.md) for the one-time setup.
+
+## Licences
+
+pypts is distributed under the **LGPL-2.1-or-later** licence.
+
+pypts comes with a [dependency licence compatibility analysis report](https://acc-py.web.cern.ch/gitlab/pts/framework/pypts/docs/stable/dependency_license_analysis.html).

pts_framework-0.6.1/README.md

@@ -0,0 +1,55 @@
+<!--
+SPDX-FileCopyrightText: 2025 CERN <home.cern>
+
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
+# pypts
+
+![pypts quick run](images/pypts_quick_run.gif)
+
+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).
+
+For full documentation, please visit [PTS Framework Documentation](https://acc-py.web.cern.ch/gitlab/pts/framework/pypts/docs/stable/).
+
+=======
+
+## Continuous integration and releases
+
+The project is tested in a disposable Python 3.13 Docker image. To reproduce the
+GitHub CI build locally, run:
+
+```sh
+docker build --build-arg SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PTS_FRAMEWORK=0+local -t pts-framework-ci .
+docker run --rm pts-framework-ci
+```
+
+Creating a protected `vX.Y.Z` tag runs the same tests, builds the wheel and source
+distribution, and publishes them to TestPyPI. Verify the TestPyPI package in a clean
+environment before approving the `pypi` GitHub Environment:
+
+```sh
+python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pts-framework==X.Y.Z
+```
+
+Approval publishes the same distributions to PyPI. GitHub retains the release
+artifact for 30 days; PyPI is the permanent package source. See
+[release configuration](.github/RELEASE.md) for the one-time setup.
+
+## Licences
+
+pypts is distributed under the **LGPL-2.1-or-later** licence.
+
+pypts comes with a [dependency licence compatibility analysis report](https://acc-py.web.cern.ch/gitlab/pts/framework/pypts/docs/stable/dependency_license_analysis.html).

pts_framework-0.6.1/pyproject.toml

@@ -0,0 +1,141 @@
+# SPDX-FileCopyrightText: 2025 CERN <home.cern>
+#
+# SPDX-License-Identifier: LGPL-2.1-or-later
+
+[build-system]
+requires = ["setuptools", "wheel", "setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pts-framework"
+dynamic = [
+  "version",  # The version is taken directly from the repository, using setuptools-scm.
+]
+description = "Hardware-oriented testing framework developed by BE-CEM-MTA"
+readme = "README.md"
+license = "LGPL-2.1-or-later"
+keywords = ["testing", "hardware", "instrumentation", "cern"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Science/Research",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.13",
+  "Operating System :: OS Independent",
+]
+authors = [
+  { name = "Odd Oyvind Andreassen", email = "odd.oyvind.andreassen@cern.ch" },
+  { name = "Bartlomiej Banas", email = "Bartlomiej.Banas@cern.ch" },
+  { name = "Oliver Damborg", email = "odamborg@cern.ch" },
+  { name = "Alvaro Martinez Landete", email = "alvaro.martinez.landete@cern.ch" },
+]
+# Specify the minimum Python version required. It is not safe to use
+# this to control the *upper* version of Python.
+requires-python = ">=3.13"
+
+# The core dependencies of the project.
+dependencies = [
+  "hightime==0.2.2",
+  "matplotlib",
+  "nidmm==1.4.8",
+  "numpy",
+  "PySide6==6.9.1",
+  "PyYAML==6.0.2",
+  "ruamel.yaml",
+  "pymeasure==0.15.0",
+  "pyserial",
+  "paramiko",
+  "pydantic>=2.13,<3",
+  "pyvisa"
+]
+
+[project.optional-dependencies]
+# The optional dependencies of the project, installable using the "extras" syntax.
+test = [
+  "pytest",
+  "pytest-qt",
+  "pytest-cov",
+  "pytest-timeout",
+]
+doc = [
+  "Sphinx",
+]
+dev = [
+  # Dependencies for development of the project, such as type checkers,
+  # linters, etc.
+  # "requirement-for-development-purposes-only",
+
+  # Include the "test" and "doc" dependencies in the dev dependencies.
+  "pts-framework[doc,test]",
+  "ruff",
+]
+
+[project.urls]
+Homepage = "https://github.com/CERN/pts-framework"
+Repository = "https://github.com/CERN/pts-framework"
+Changelog = "https://github.com/CERN/pts-framework/blob/master/CHANGELOG.md"
+
+[project.scripts]
+init_env_min = "pypts.examples.environment_setup_tools.Minimal_setup.init_env_min:main"
+init_env_pack = "pypts.examples.environment_setup_tools.Package_based_setup.init_env_pack:main"
+
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["pypts", "pypts.*"]
+
+[tool.setuptools.package-data]
+"pypts.examples.environment_setup_tools.Minimal_setup" = [
+  "Minimal_setup_recipe.yml",
+  "README.md",
+  "tests/example_tests.py",
+]
+"pypts.examples.environment_setup_tools.Package_based_setup" = [
+  "Package_based_recipe.yml",
+  "README.md",
+  "pyproject.toml",
+  "tests/example_tests.py",
+]
+
+[tool.setuptools_scm]
+# Tell setuptools_scm to write a _version.py file in the package. The
+# _version.py file must not be committed to the repository.
+version_file = "src/pypts/_version.py"
+
+[tool.acc_py_template]
+features = [
+  {name = "core", version = 2},
+  {name = "docs", version = 2},
+]
+
+[tool.pytest.ini_options]
+minversion = "7.0"
+addopts = "--strict-markers"
+timeout = 90
+faulthandler_timeout = 60
+testpaths = ["tests"]
+markers = [
+    "unit: unit tests",
+    "functional: functional tests",
+]
+
+[tool.coverage.run]
+source = ["src/pypts"]
+omit = [
+    "*/tests/*",
+    "*/test_*.py",
+    "*/__pycache__/*",
+    "*/site-packages/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+]
+precision = 2

pts_framework-0.6.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pts_framework-0.6.1/src/pts_framework.egg-info/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: pts-framework
+Version: 0.6.1
+Summary: Hardware-oriented testing framework developed by BE-CEM-MTA
+Author-email: Odd Oyvind Andreassen <odd.oyvind.andreassen@cern.ch>, Bartlomiej Banas <Bartlomiej.Banas@cern.ch>, Oliver Damborg <odamborg@cern.ch>, Alvaro Martinez Landete <alvaro.martinez.landete@cern.ch>
+License-Expression: LGPL-2.1-or-later
+Project-URL: Homepage, https://github.com/CERN/pts-framework
+Project-URL: Repository, https://github.com/CERN/pts-framework
+Project-URL: Changelog, https://github.com/CERN/pts-framework/blob/master/CHANGELOG.md
+Keywords: testing,hardware,instrumentation,cern
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: hightime==0.2.2
+Requires-Dist: matplotlib
+Requires-Dist: nidmm==1.4.8
+Requires-Dist: numpy
+Requires-Dist: PySide6==6.9.1
+Requires-Dist: PyYAML==6.0.2
+Requires-Dist: ruamel.yaml
+Requires-Dist: pymeasure==0.15.0
+Requires-Dist: pyserial
+Requires-Dist: paramiko
+Requires-Dist: pydantic<3,>=2.13
+Requires-Dist: pyvisa
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-qt; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-timeout; extra == "test"
+Provides-Extra: doc
+Requires-Dist: Sphinx; extra == "doc"
+Provides-Extra: dev
+Requires-Dist: pts-framework[doc,test]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+
+<!--
+SPDX-FileCopyrightText: 2025 CERN <home.cern>
+
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
+# pypts
+
+![pypts quick run](images/pypts_quick_run.gif)
+
+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).
+
+For full documentation, please visit [PTS Framework Documentation](https://acc-py.web.cern.ch/gitlab/pts/framework/pypts/docs/stable/).
+
+=======
+
+## Continuous integration and releases
+
+The project is tested in a disposable Python 3.13 Docker image. To reproduce the
+GitHub CI build locally, run:
+
+```sh
+docker build --build-arg SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PTS_FRAMEWORK=0+local -t pts-framework-ci .
+docker run --rm pts-framework-ci
+```
+
+Creating a protected `vX.Y.Z` tag runs the same tests, builds the wheel and source
+distribution, and publishes them to TestPyPI. Verify the TestPyPI package in a clean
+environment before approving the `pypi` GitHub Environment:
+
+```sh
+python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pts-framework==X.Y.Z
+```
+
+Approval publishes the same distributions to PyPI. GitHub retains the release
+artifact for 30 days; PyPI is the permanent package source. See
+[release configuration](.github/RELEASE.md) for the one-time setup.
+
+## Licences
+
+pypts is distributed under the **LGPL-2.1-or-later** licence.
+
+pypts comes with a [dependency licence compatibility analysis report](https://acc-py.web.cern.ch/gitlab/pts/framework/pypts/docs/stable/dependency_license_analysis.html).

pts_framework-0.6.1/src/pts_framework.egg-info/SOURCES.txt

@@ -0,0 +1,63 @@
+README.md
+pyproject.toml
+src/pts_framework.egg-info/PKG-INFO
+src/pts_framework.egg-info/SOURCES.txt
+src/pts_framework.egg-info/dependency_links.txt
+src/pts_framework.egg-info/entry_points.txt
+src/pts_framework.egg-info/requires.txt
+src/pts_framework.egg-info/top_level.txt
+src/pypts/__init__.py
+src/pypts/__main__.py
+src/pypts/_version.py
+src/pypts/clim_chamber.py
+src/pypts/common.py
+src/pypts/dev_tests.py
+src/pypts/event_proxy.py
+src/pypts/example_tests.py
+src/pypts/exceptions.py
+src/pypts/gui.py
+src/pypts/gui_theme.py
+src/pypts/pts.py
+src/pypts/recipe.py
+src/pypts/recipe_artifacts.py
+src/pypts/recipe_language.py
+src/pypts/recipe_parser.py
+src/pypts/recipe_reference.py
+src/pypts/report.py
+src/pypts/startup.py
+src/pypts/steps.py
+src/pypts/utils.py
+src/pypts/XYGraph/StreamContainer.py
+src/pypts/XYGraph/XY_graph.py
+src/pypts/XYGraph/simulated_signals.py
+src/pypts/YamVIEW/__init__.py
+src/pypts/YamVIEW/customGUIModules.py
+src/pypts/YamVIEW/recipe_creator.py
+src/pypts/YamVIEW/recipe_sequencer_setup.py
+src/pypts/YamVIEW/recipe_step_setup.py
+src/pypts/YamVIEW/styles.py
+src/pypts/YamVIEW/verify_recipe.py
+src/pypts/examples/environment_setup_tools/Minimal_setup/Minimal_setup_recipe.yml
+src/pypts/examples/environment_setup_tools/Minimal_setup/README.md
+src/pypts/examples/environment_setup_tools/Minimal_setup/init_env_min.py
+src/pypts/examples/environment_setup_tools/Minimal_setup/tests/example_tests.py
+src/pypts/examples/environment_setup_tools/Package_based_setup/Package_based_recipe.yml
+src/pypts/examples/environment_setup_tools/Package_based_setup/README.md
+src/pypts/examples/environment_setup_tools/Package_based_setup/init_env_pack.py
+src/pypts/examples/environment_setup_tools/Package_based_setup/pyproject.toml
+src/pypts/examples/environment_setup_tools/Package_based_setup/tests/example_tests.py
+src/pypts/gui_components/__init__.py
+src/pypts/gui_components/interaction_panel.py
+src/pypts/gui_components/log_panel.py
+src/pypts/gui_components/resources.py
+src/pypts/gui_components/results_panel.py
+src/pypts/gui_components/step_table.py
+src/pypts/gui_components/styles.py
+src/pypts/gui_components/toolbar.py
+src/pypts/instruments/__init__.py
+src/pypts/instruments/pendulum/__init__.py
+src/pypts/instruments/pendulum/cnt91.py
+src/pypts/recipes/shared_object_example.py
+src/pypts/recipes/shared_resource_client.py
+src/pypts/recipes/shared_resource_server.py
+src/pypts/recipes/shared_resource_tests_example.py

pts_framework-0.6.1/src/pts_framework.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pts_framework-0.6.1/src/pts_framework.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+init_env_min = pypts.examples.environment_setup_tools.Minimal_setup.init_env_min:main
+init_env_pack = pypts.examples.environment_setup_tools.Package_based_setup.init_env_pack:main

pts_framework-0.6.1/src/pts_framework.egg-info/requires.txt

@@ -0,0 +1,25 @@
+hightime==0.2.2
+matplotlib
+nidmm==1.4.8
+numpy
+PySide6==6.9.1
+PyYAML==6.0.2
+ruamel.yaml
+pymeasure==0.15.0
+pyserial
+paramiko
+pydantic<3,>=2.13
+pyvisa
+
+[dev]
+pts-framework[doc,test]
+ruff
+
+[doc]
+Sphinx
+
+[test]
+pytest
+pytest-qt
+pytest-cov
+pytest-timeout

pts_framework-0.6.1/src/pts_framework.egg-info/top_level.txt

@@ -0,0 +1 @@
+pypts

pts_framework-0.6.1/src/pypts/XYGraph/StreamContainer.py

@@ -0,0 +1,67 @@
+# SPDX-FileCopyrightText: 2025 CERN (home.cern)
+#
+# SPDX-License-Identifier: LGPL-2.1-or-later
+
+class GlobalContainer:
+    _instance = None
+    def __new__(cls, *args, **kwargs):
+
+        print("Something is creating the container object")
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+            cls._instance.streamlist = []
+        return cls._instance
+
+    def remove_stream(self, Stream):
+        self.streamlist.remove(Stream)
+
+    def add_stream(self, Stream):
+        self.streamlist.append(Stream)
+
+    def get_stream(self, key):
+        return self.streamlist[key]
+
+    def get_all_streams(self):
+        return list(self.streamlist)
+
+    def get_streams_info(self):
+        streams_info = ""
+        print(f"container object inside the streams_info: {container}")
+        for stream in self.streamlist:
+            streams_info = streams_info + (f"Retrieved registered stream {stream.name}. Stream is tied with {stream.hook} hook.\n")
+        return streams_info
+
+global container
+container = GlobalContainer()
+
+class Stream:
+    def __init__(self, name, hook, description=None, unit=None, frequency=None):
+        self.name = name
+        self.hook = hook
+        self.description = description
+        self.unit = unit
+        self.frequency = frequency
+        container.add_stream(self)
+
+    def kill(self):
+        container.remove_stream(self)
+        del(self)
+#
+# if __name__ == "__main__":
+#     stream1 = Stream(name = "PT100 probe", hook = "file1.csv")
+#     stream2 = Stream(name = "oscilloscope", hook = "file2.csv")
+#
+#     # container = GlobalContainer()
+#     # print("Adding 1st stream")
+#     # container.add_stream(stream1)
+#     # print(container.get_streams_info())
+#     # print("Adding 2nd stream")
+#     # container.add_stream(stream2)
+#     # print(container.get_streams_info())
+#
+#     import time
+#     while True:
+#         time.sleep(1)
+#         streamlist = container.get_all_streams()
+#         for stream in streamlist:
+#             print(f"Retrieved registered stream {stream.name}. Stream is tied with {stream.hook} hook.")