summaryrefslogtreecommitdiff
path: root/.github/workflows/python-publish.yml
diff options
context:
space:
mode:
authorRoberto Bertó <463349+robertoberto@users.noreply.github.com>2026-05-19 03:02:52 +0000
committerRoberto Bertó <463349+robertoberto@users.noreply.github.com>2026-05-19 03:02:52 +0000
commitb2f1765d286502307ea07a62648718d0414e4f39 (patch)
treecf36ad0de5167cdc75ffb3d4b0533a68752c0019 /.github/workflows/python-publish.yml
parent4c19d27c2cf87176dfb983ccc65f2c817ff1f650 (diff)
downloadpyvyos-b2f1765d286502307ea07a62648718d0414e4f39.tar.gz
pyvyos-b2f1765d286502307ea07a62648718d0414e4f39.zip
docs: split examples into read-only basic and guarded smoke
The previous examples/basic.py ran destructive operations (configure_set, configure_delete, generate, reset, config_file_load) by default. That is not what a public 'basic' example should do. - examples/basic.py: rewritten as a read-only example (retrieve_show_config, show, retrieve_return_values), uses a robust env-bool parser, prints response.result via a small helper, and uses the supported public import 'from pyvyos import ApiResponse, VyDevice'. - examples/integration_smoke.py: renamed from the old basic.py, keeps the mutating operations, and refuses to run unless PYVYOS_ALLOW_MUTATING_EXAMPLE=1 is set. - README: link both examples and describe what each one does. Note: the dev/ note about a future Docker-based e2e harness is tracked in the unreleased issue drafts; it is not part of this release.
Diffstat (limited to '.github/workflows/python-publish.yml')
0 files changed, 0 insertions, 0 deletions