diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f4ff0ac --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,32 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [0.6.1] - 2028-08-27 + +- Add CHANGELOG.md +- No changes in software code + +## [0.6.0] - 2026-08-14 + +### Added + +- Progress bar shown during test execution, with accompanying unit tests. +- Pydantic-validated recipe language step model, replacing the previous + recipe parser. + +### Fixed + +- Packaging: include required `.yml` and example files so the CI-built + package works correctly. +- Documentation build: removed a stale `_static` reference. + +### Note + +Versions prior to 0.6.0 (`v0.1`-`v0.5.1`) predate this changelog; see the +git history and GitHub tags for that history. diff --git a/TODO.txt b/TODO.txt deleted file mode 100644 index 35763ac..0000000 --- a/TODO.txt +++ /dev/null @@ -1,34 +0,0 @@ -# SPDX-FileCopyrightText: 2025 CERN -# -# SPDX-License-Identifier: LGPL-2.1-or-later - - -#todo 1.1 - do not expect anything from the called test function -#todo 1.1 x Implement popup step type for input and/or output -#todo 1.1 x implement execution GUI with callbacks -#todo 1.1 - implement reporting with callbacks -#todo 1.1 - implement step by step execution (repeat steps as needed or even go back) -#todo 1.1 - implement proper error handling at all levels -#todo 1.1 - step results stored in sequence object or at a higher level in hierarchical way? -#todo 1.1 - conditional execution of step based on variable -#todo 1.1 x provide unified string variable access by name -#todo 1.1 x steps need proper IDs -#todo 1.1 ? implement repeat as unrolling -#todo 1.1 x run all in same environment -#todo 1.1 - needs to be able to run without GUI and with cli parameters -#todo 1.1 x sequence yaml file should contain all sequences as well as top-level info on the test - -#todo bugfix - the GUI (both recipe creator and main GUI) do not refresh always properly -#todo discuss the general development strategy (how do we cooperate well) -#todo semi-important - write unit tests for the signal proxy, more informations in tests/unit_tests/test_event_proxy -#todo minor - allow the application to start without providing any DUT -#todo - move the generated html report out of the environment and git, so its not versioned and the reports are being generated locally - -#todo - change the self.globals type to dictionary, co we can access them by name, not just have the values in list. It is located in recipe.py/runtime class - -#todo - add X server on the gitlab server, so it is possible to run GUI tests - -#todo - ensure correct handling of the requirements/pyproject.toml (everything shall be in toml and then we delete requirements - -#todo - implement usage of reuse on the gitlab CI, structurize the licensing, document it on the .rst file - diff --git a/pyproject.toml b/pyproject.toml index c3fa973..e177cc0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,16 +11,21 @@ name = "pts-framework" dynamic = [ "version", # The version is taken directly from the repository, using setuptools-scm. ] -# description = "" +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 = "Joseph Tagg", email = "joseph.tagg@cern.ch" }, - { name = "Bartlomiej Banas", email = "joseph.tagg@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 @@ -65,8 +70,9 @@ dev = [ ] [project.urls] -# Homepage = "PyPTS repository" -Repository = "https://gitlab.cern.ch/pts/framework/pypts" +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"