Skip to content

Follow the plugin template: acceptance checks, shared workflows, AGENTS.md - #2

Open
seb5g wants to merge 3 commits into
5.0.xfrom
feature/plugin_acceptance_tests
Open

seb5g wants to merge 3 commits into
5.0.xfrom
feature/plugin_acceptance_tests

Conversation

@seb5g

@seb5g seb5g commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

Brings this plugin in line with pymodaq_plugins_template (branch 5.3.x). This replaces the first version of this pull request, which only changed the test file.

  • tests/test_plugin_package_structure.py: the generic copy of the template tests is replaced by the stub using the plugin acceptance checks of PyMoDAQ (pymodaq.utils.plugin_testing, PyMoDAQ >= 5.3.2, see the documentation). They check the naming of the modules and classes, the base class and mandatory methods, _axis_names / _controller_units / _epsilons, the settings tree, the entry points and static rules on the sources. Unfinished work (TODO comments) is listed, not failing. A module that cannot be imported because a vendor driver is missing on the CI runner is skipped, not failed. The module is skipped when PyMoDAQ is older than 5.3.2.
  • .github/workflows: the copies of the workflows (Test.yml, Testbase.yml, updater.yml, old python-publish.yml) are replaced by three small files calling the reusable workflows hosted in pymodaq_plugins_template: tests.yml (one fast configuration), compatibility.yml (Python 3.10 to 3.13, PyQt5/PyQt6/PySide6, Linux and Windows) and python-publish.yml (same release trigger and the same PYPI_USERNAME / PYPI_PASSWORD secrets as before). Nothing to update here anymore when GitHub actions or Python versions change.
  • AGENTS.md and CLAUDE.md: guidance for AI coding assistants working on the plugin (the PyMoDAQ plugin contract, units, is_master, tests).

The pymodaq requirement of pyproject.toml is not changed. You can also run check_plugin (PyMoDAQ >= 5.3.1) in the folder of the plugin to get the full report, with the hints to fix each finding.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg


Generated by Claude Code

seb5g and others added 3 commits October 7, 2026 00:37
Replace the copy of the generic tests of the plugin template by the stub using
pymodaq_utils.plugin_testing (see pymodaq_plugins_template PR 43). The module is skipped with
older versions of PyMoDAQ.

Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
…ld not be built nor the tests run)

Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
…_testing, shared workflows, AGENTS.md

Remove the copies of the workflows (Test.yml, Testbase.yml, updater.yml) and call the reusable ones of
pymodaq_plugins_template; add AGENTS.md and CLAUDE.md for AI coding assistants.

Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg
@seb5g seb5g changed the title Use the plugin acceptance checks provided by PyMoDAQ 5.3.1 Follow the plugin template: acceptance checks, shared workflows, AGENTS.md Oct 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants