For the best development experience use VSCode with the Remote Containers extension. This maps your workspace into a checkmk docker container giving you access to the python environment and libraries the installed extension has.
It is necessary to adapt the package file and store all files there. The name of the plugin must be identical to the CheckMK Plugin Python Package (cmk_addons/plugins/NAME) and the corresponding Pytests (tests/cmk_addons/plugins/NAME). The name TEMPLATE must initially be renamed to PLUGINNAME.
The following directories in this repo are getting mapped into the Checkmk site.
libis mapped tolocal/lib/python3/cmkcmk_addonsis mapped tolocal/lib/python3/cmk_addonstmpis mapped tolocal/tmpfor storing static agent output
To build the package hit Crtl+Shift+B to execute the build task in VSCode.
pytest can be executed from the terminal or the test ui.
The provided Github Workflows run pytest and ruff in the same checkmk docker container as vscode.
In addition, the releases are automatically built with the build action.