testsuit 0.1.1__tar.gz

testsuit-0.1.1/.editorconfig

@@ -0,0 +1,19 @@
+# https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+
+[*.{yml,yaml,json,toml}]
+indent_style = space
+indent_size = 2
+
+# pyproject.toml and README.md are stored with Windows line endings
+[{pyproject.toml,README.md}]
+end_of_line = crlf

testsuit-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,58 @@
+name: publish
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+  id-token: write   # required for PyPI trusted publishing (OIDC)
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build
+        run: python -m pip install --upgrade build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Upload dist to job artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Get PyPI token
+        id: get_pypi_token
+        run: |
+          response=$(curl -sf -H "Authorization: Bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "${ACTIONS_ID_TOKEN_REQUEST_URL}&audience=pypi")
+          echo "id_token=$(echo "$response" | jq -r .value)" >> "$GITHUB_OUTPUT"
+
+      - name: Publish to PyPI
+        env:
+          TWINE_NON_INTERACTIVE: 1
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ steps.get_pypi_token.outputs.id_token }}
+        run: |
+          python -m pip install twine
+          python -m twine upload --repository pypi dist/*

testsuit-0.1.1/.github/workflows/tests.yml

@@ -0,0 +1,72 @@
+name: tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Ruff (runtime errors and bug-prone patterns, see [tool.ruff] in pyproject.toml)
+        run: |
+          python -m pip install ruff
+          ruff check .
+
+  pytest:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # setuptools-scm needs history/tags for the version
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[test]"
+      - name: Run tests
+        run: python -m pytest -q
+
+  example:
+    # examples/acme_testbench: a separate package extending testsuit through its plugin entry point
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install testsuit and the example
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .
+          python -m pip install -e "examples/acme_testbench[test]"
+      - name: Run the example's tests
+        working-directory: examples/acme_testbench
+        run: python -m pytest -q
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build sdist and wheel
+        run: |
+          python -m pip install build
+          python -m build

testsuit-0.1.1/.gitignore

@@ -0,0 +1,19 @@
+__pycache__
+.ipynb_checkpoints
+*.pyc
+*.ipynb
+# starter notebooks shipped with the package (testsuit-notebooks command)
+!src/testsuit/jupytertools/notebooks/*.ipynb
+demo_data
+*.tmp
+tmp/
+.current_datapack
+# for testing datapack import
+dataset.dico
+.dataset.dico
+tests/etc/mexploit/scenarii/*/conftest.py
+.venv
+.current_datapack
+*.egg-info/
+build/
+dist/

testsuit-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,118 @@
+# Contributing
+
+## Setup
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+ruff check .
+```
+
+Both commands must pass before a pull request is merged; CI runs them on Python 3.10 and 3.12 and also builds the package.
+
+## Conventions
+
+- All code lives in the `testsuit` package under `src/testsuit/` and is imported as `testsuit.datatools...`, `testsuit.misc...`, never through `sys.path` edits.
+- Command-line tools live in `src/testsuit/cli/`. Keep the logic in an importable function (for example `data2h5()` in `cli/data2h5.py`) and put argument parsing in `main()`, so tests can call the function directly.
+- Tests are `tests/<topic>_t.py`. Their inputs go in `tests/etc/`, the expected outputs they compare against go in `tests/ref/`, and anything they write goes under `tests/tmp/` (ignored by git).
+- New runtime dependencies go in `[project].dependencies` of `pyproject.toml`; dependencies only needed by one feature go in an extra under `[project.optional-dependencies]`.
+- Versions come from git tags (setuptools-scm): tag a release as `vX.Y.Z` on `main`.
+
+## Adding a data file format
+
+1. Create `src/testsuit/datatools/DataFileMgrs/<Format>FileMgr.py` with a class deriving from `AFileMgr` (see `CsvFileMgr.py` or `MdfFileMgr.py` for complete examples).
+2. Register it at the end of `src/testsuit/datatools/DataFileMgrs/formats.py` with `register_file_format(..., builtin=True)`, using a factory that imports your module, so its dependencies are only needed when such a file is loaded. This also adds its extensions to `SUPPORTED_DATAFILE_EXTENSIONS`.
+   A new CSV syntax is a `CsvFileMgr` subclass registered with `register_csv_variant(..., builtin=True)` instead.
+3. Add a sample file under `tests/etc/data/` and a case in `tests/loaddata_t.py`.
+
+## Adding a command-line tool
+
+1. Add `src/testsuit/cli/<name>.py` with a `main()` that parses arguments and calls an importable function.
+2. Register it under `[project.scripts]` in `pyproject.toml` as `<name> = "testsuit.cli.<name>:main"`.
+3. Re-run `pip install -e .` so the command is created, and list it in the README.
+
+## Adding a mexploit check
+
+A scenario entry `type: foo` runs the criterion `foo`, a function `crit_foo(critConf, ...)`. It is looked up in the scenario's own libraries first, then in the criteria registered by external code, then in the default ones.
+
+- For a check everyone can use, add `crit_foo` to `src/testsuit/exploit/mexploit/criteria.py` and cover it with a scenario under `tests/etc/mexploit/scenarii/mxp_OK_main_functions/`.
+- For a project-specific check, keep it outside this repo: either register it from your library (see below), or write `crit_foo` in your own module and load it from the scenario with a `# MXP_REGISTER_CRITLIB(path/to/your_criteria.py)` line, as in `tests/etc/mexploit/scenarii/mxp_OK_custom_crit/`.
+
+## Extending testsuit from another library
+
+An application built on testsuit can add formats, criteria, datapack importers and its own report logo without changing this repo. The extension points are tested in `tests/extensions_t.py`. `examples/acme_testbench` is a complete example project using all of them, with its own tests run by CI.
+
+### Data file formats
+
+```python
+from testsuit.datatools.DataFileMgrs.formats import register_file_format, register_csv_variant
+from testsuit.datatools.DataFileMgrs.CsvFileMgr import CsvFileMgr
+
+# a brand new format: extensions and a factory(filename, fileIdx), usually an AFileMgr subclass
+register_file_format("myformat", ["myf"], MyFormatFileMgr)
+
+# a known reader for another extension
+register_file_format("mylogs", ["mlog"], CsvFileMgr)
+
+# a CSV syntax, detected from the file (here its first line), read by a CsvFileMgr subclass
+register_csv_variant("mylogger",
+                     lambda filename: open(filename).readline().startswith("#MYLOGGER"),
+                     MyLoggerCsvFileMgr)
+```
+
+Registered formats are tried before the built-in ones, so they can also take over a built-in extension; `accepts=lambda filename: ...` limits a format to some of the files with its extensions. `FolderParamMgr`, `loadDataframeFromFile()` and the command-line tools then load these files like the built-in ones.
+
+### mexploit criteria
+
+```python
+from testsuit.exploit.mexploit.registry import register_criterion, register_criteria_module
+
+@register_criterion                      # scenario entries 'type: my_check'
+def crit_my_check(critConf):
+    assert critConf["value"] < critConf["maxValue"], "value too high"
+
+register_criteria_module("mylib.mexploit_criteria")   # every crit_* function of that module
+```
+
+Criteria can use the mexploit fixtures and helpers exactly like the ones in `criteria.py`.
+
+### HTML report logo
+
+The exploit_runner report starts with an animated "M-Exploit" logo (`report_html.make_report_logo_svg()`). To use your own:
+
+```python
+exploit_runner(conf_file, report_logo_title="ACME Bench")        # same animated logo, your title
+exploit_runner(conf_file, report_logo_svg="path/to/logo.svg")    # your SVG (file or markup), "" for none
+
+from testsuit.exploit.runner.report_html import set_default_report_logo
+set_default_report_logo(svg="path/to/logo.svg")    # or title="ACME Bench": every report of the process
+```
+
+From the command line: `exploit_runner --report-logo logo.svg` or `--report-logo-title "ACME Bench"`.
+
+### datapack importers
+
+```python
+from testsuit.datatools.datapack.importers import register_data_importer
+
+# datasource 'importer: myserver' in datapack setup files; any factory(targetDir, remotePath, versionId)
+register_data_importer("myserver", MyServerImporter)   # an ADataImporter subclass
+```
+
+`remotePath` is the datasource `path`, `versionId` the dataset `path`. After `retrieve()`, the dataset folder must contain a `dataset.dico` file, whose keys the datapack files can use. `git` is the built-in importer.
+
+### Making registrations visible to the command-line tools
+
+The calls above are enough when your code runs testsuit in its own process (`mexploit()`, `exploit_runner()`, `FolderParamMgr`). The command-line tools, and the `mxp` processes that exploit_runner starts for each test run, only see them when they come from a plugin, loaded by `testsuit.plugins.load_plugins()`:
+
+- declare an entry point in your package; its target is called without argument:
+
+  ```toml
+  [project.entry-points."testsuit.plugins"]
+  mylib = "mylib.testsuit_plugin:register"
+  ```
+
+- or list modules in the `TESTSUIT_PLUGINS` environment variable (`module` or `module:function`, comma-separated; a module given alone has its `register()` called if it defines one). Child processes inherit it.
+
+A plugin that fails to load is logged as a warning and skipped.

testsuit-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

testsuit-0.1.1/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: testsuit
+Version: 0.1.1
+Summary: Toolbox for preparing and analysing tests data
+Author: Laurent Millet-Lacombe
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/laurentmldev/testsuit
+Project-URL: Source, https://github.com/laurentmldev/testsuit
+Project-URL: Issues, https://github.com/laurentmldev/testsuit/issues
+Keywords: test data,hdf5,tdms,mdf,csv,data analysis,test campaign
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=2.2.6
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: requests>=2.32.5
+Requires-Dist: GitPython>=3.1
+Requires-Dist: colorama>=0.4
+Requires-Dist: h5py>=3.15
+Requires-Dist: Unidecode>=1.4
+Requires-Dist: pytest-html>=4.1
+Requires-Dist: pytest-metadata>=3.1
+Requires-Dist: matplotlib>=3.10
+Requires-Dist: asammdf>=8.7
+Requires-Dist: pytest>=8
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: ruamel.yaml>=0.18
+Requires-Dist: Markdown>=3.5
+Requires-Dist: python-dateutil>=2.8
+Requires-Dist: npTDMS>=1.10
+Requires-Dist: dwdatareader>=1.3
+Provides-Extra: plotly
+Requires-Dist: plotly>=5; extra == "plotly"
+Provides-Extra: jupyter
+Requires-Dist: ipython>=8; extra == "jupyter"
+Requires-Dist: ipywidgets>=8; extra == "jupyter"
+Requires-Dist: nbclassic>=1.0; extra == "jupyter"
+Provides-Extra: influxdb
+Requires-Dist: influxdb-client>=1.40; extra == "influxdb"
+Requires-Dist: influxdb3-python>=0.10; extra == "influxdb"
+Requires-Dist: pyarrow>=15; extra == "influxdb"
+Provides-Extra: test
+Requires-Dist: plotly>=5; extra == "test"
+Provides-Extra: dev
+Requires-Dist: testsuit[test]; extra == "dev"
+Requires-Dist: build>=1.3; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# testsuit
+
+Toolbox for preparing and analysing test data: load measurement files (CSV, TDMS, MDF, Dewesoft DXD, UDBF, HDF5, InfluxDB) into pandas, convert them to HDF5 or push them to a database, check results against YAML scenarios, and package test inputs into datapacks.
+
+## Installation
+
+Python 3.10 or newer is required.
+
+```bash
+git clone https://github.com/laurentmldev/testsuit.git
+cd testsuit
+python -m venv .venv && source .venv/bin/activate   # Windows: .venv\Scripts\activate
+pip install -e .
+```
+
+Optional features are installed as extras:
+
+| Extra      | Adds                                         |
+|------------|----------------------------------------------|
+| `plotly`   | interactive plots in mexploit reports        |
+| `jupyter`  | notebook GUIs (`jupytertools`)               |
+| `influxdb` | InfluxDB readers and `data2db` targets       |
+| `test`     | what the test suite needs                    |
+| `dev`      | `test` plus build and lint tools             |
+
+For example `pip install -e ".[plotly,jupyter]"`.
+
+To use testsuit without cloning it, install straight from GitHub (add `@<tag>` to pin a version):
+
+```bash
+pip install "testsuit[jupyter] @ git+https://github.com/laurentmldev/testsuit.git"
+```
+
+## Jupyter GUIs
+
+Three notebook GUIs come with the package: Data-Plot (browse and plot parameters), H5-Conv (convert data files to HDF5) and M-Exploit (run a scenario and view its report). Copy their starter notebooks into a working folder and open Jupyter there:
+
+```bash
+pip install "testsuit[jupyter]"          # or: pip install -e ".[jupyter]" from a clone
+testsuit-notebooks ~/my_analysis --open  # copies data_plot, h5_convert and mexploit .ipynb
+```
+
+The notebooks only call `runGUI()` from the installed package, so upgrading testsuit upgrades the GUIs without copying the notebooks again (`--force` refreshes them). The GUIs need the classic notebook UI (`jupyter nbclassic`, what `--open` starts), and a desktop session for their file dialogs (tkinter).
+
+## Repository layout
+
+```
+src/testsuit/           the installable package
+  datatools/            load data files into pandas, convert to HDF5, push to a DB
+    DataFileMgrs/       one reader per file format (Csv, Tdms, Mdf, Dxd, Udbf, H5, InfluxDb)
+    datapack/           datapack generation: dictionaries, includes, key replacement
+  exploit/
+    mexploit/           YAML scenario checks (corridors, sequences, computed params, plots) run through pytest
+    runner/             runs mexploit over test sessions and builds HTML reports
+  jupytertools/         ipywidgets GUIs for notebooks
+  misc/                 logging, progress reporting, file helpers
+  cli/                  command-line tools (see below)
+examples/               sample configuration files, and acme_testbench: a library extending testsuit
+tests/                  pytest suite (*_t.py)
+  etc/                  input data, scenarios and configs used by the tests
+  ref/                  reference outputs the tests compare against
+```
+
+## Command-line tools
+
+Installing the package puts these commands on your `PATH`. Each prints its full usage with `--help`, for example `data2h5 --help`. They can also be run as `python -m testsuit.cli.<name>`.
+
+| Command                  | Purpose                                                           |
+|--------------------------|-------------------------------------------------------------------|
+| `data2h5`                | extract parameters from data files or folders into an HDF5 file   |
+| `data2db`                | push parameters from data files into a database (InfluxDB, ClickHouse) |
+| `extract_data_any`       | decode raw bit fields into parameters from a JSON/YAML config (example: `examples/config_extract_data_any.json`) |
+| `extract_data_flags`     | extract flag values described in a YAML file                      |
+| `apply_clock_correction` | shift timestamps of a folder of data files                        |
+| `mxp`                    | run a mexploit scenario folder against data folders               |
+| `exploit_runner`         | run mexploit over whole test sessions from a YAML config          |
+| `datapack`               | generate a datapack from a test definition file                   |
+| `evalfile`               | resolve includes and keys in a file from dictionaries             |
+| `testsuit-notebooks`     | copy the Jupyter GUI notebooks into a folder, optionally open Jupyter |
+
+## Using the library
+
+```python
+from testsuit.datatools.datatoolbox import loadDataframeFromFile
+from testsuit.exploit.mexploit.mexploit import mexploit
+
+# run the checks of a scenario folder on a data folder, results written to out/
+dfs = loadDataframeFromFile("tests/etc/data/csv/flags.csv", ".*")  # one DataFrame per parameter
+
+rc = mexploit("tests/etc/mexploit/scenarii/mxp_OK_main_functions", "tests/etc/data", "out/", force=True)
+```
+
+The scenarios under `tests/etc/mexploit/scenarii/` are working examples of every check type.
+
+## Running the tests
+
+```bash
+pip install -e ".[dev]"
+pytest          # runs tests/*_t.py
+ruff check .    # catches runtime errors such as undefined names
+```
+
+CI (`.github/workflows/tests.yml`) runs the same lint, the tests on Python 3.10 and 3.12, and a package build, on every pull request.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for how to add a file format, a mexploit check or a script, and how another library can register its own formats, criteria and report logo.
+
+## License
+
+Apache License 2.0, see [LICENSE](LICENSE).
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR OR ITS COMPANY 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.