pyvyos.git/examples/basic.py, branch dependabot/github_actions/actions/setup-python-6.3.0Python SDK for interacting with VyOS API (mirror of https://github.com/vyos-contrib/pyvyos.git)
https://git.amelek.net/vyos-contrib/pyvyos.git/atom?h=dependabot%2Fgithub_actions%2Factions%2Fsetup-python-6.3.02026-05-19T03:02:52+00:00docs: split examples into read-only basic and guarded smoke2026-05-19T03:02:52+00:00Roberto Bertó463349+robertoberto@users.noreply.github.com2026-05-19T03:02:52+00:00urn:sha1:b2f1765d286502307ea07a62648718d0414e4f39
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.
docs: correct README and example to match actual API2026-05-19T02:57:11+00:00Roberto Bertó463349+robertoberto@users.noreply.github.com2026-05-19T02:57:11+00:00urn:sha1:4c19d27c2cf87176dfb983ccc65f2c817ff1f650
- configure_multiple_op uses op_path=, not path=
- ApiResponse.result is dict | list | str | None (varies per endpoint),
not just dict | list
- VYDEVICE_VERIFY_SSL parsing accepts 1/true/yes
- describe logging accurately: log records only carry structural fields
(no payload, no key); sanitization applies to ApiResponse.request, not
to logs; do not claim a NullHandler is attached (none is)
- shims at 1.0.0: phrase as a decision deferred to release time
chore: trim root, move examples, drop committed uv.lock2026-05-19T02:54:59+00:00Roberto Bertó463349+robertoberto@users.noreply.github.com2026-05-19T02:54:59+00:00urn:sha1:a2df70609a4711b4eb673f28cee3e6f72414148a
- delete CONTRIB.md (superseded by CONTRIBUTING.md)
- delete requirements.txt (duplicated [project].dependencies)
- delete test_quick.py (ad-hoc smoke covered by tests/test_shims.py)
- rewrite example.py as examples/basic.py using the public API
(from pyvyos import VyDevice) and drop the RuntimeWarning suppression
- move vagrant/ to examples/vagrant/
- stop tracking uv.lock and add it to .gitignore (library, not app)
- README: link the examples/ directory
- CHANGELOG: document the moves and removals