Python 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=docs%2Frelated-projects 2026-05-19T02:39:01+00:00 2026-05-19T02:39:01+00:00 Roberto Bertó 463349+robertoberto@users.noreply.github.com 2026-05-19T02:39:01+00:00 urn:sha1:bf4e309a698592cdb815580f97db97b268fd6668 Rewrite the README around the supported public API, add a public API stability policy, document the deprecation timeline, and refresh the CHANGELOG with the full 0.4.0 scope. Add a short CONTRIBUTING guide. Apply minor pending fixes to LICENSE and .env.example. Fix a couple of verify=False antipatterns in the docs/ pages. README: - Badges (PyPI version, Python versions, license, CI). - Quick start that actually runs (no missing import, no global disable_warnings, correct VYDEVICE_VERIFY_SSL parse). - Environment variable table with defaults. - ApiResponse contract documented as a dataclass. - Compact API overview (configure / retrieve / show / generate / reset / config-file / system / image). - Public API stability section with the 0.4 -> 0.5 -> 0.6 -> 1.0 deprecation timeline. - Logging section: NullHandler default, pyvyos logger, redacted key. - VyOS compatibility note (1.4 LTS, 1.5 rolling). - Development with uv; optional pre-commit. CHANGELOG: - Consolidated 0.4.0 entry covering both the architecture refactor and this cleanup, since 0.4.0 was tagged in git but never published. - Explicit Added / Changed / Removed / Fixed / Compatibility / Notes sections. - 0.3.0 entry annotated as 'tagged but never released to PyPI'. CONTRIBUTING.md: - Scope statement (thin HTTPS API wrapper). - Pull request rules; explicit 'do not change HTTP payload in passing'. - Development setup with uv. - Public API stability summary. Fixes from the previous review-fixes branch: - LICENSE copyright now reads 'GravScale, Roberto Berto'. - .env.example default flipped to VYDEVICE_VERIFY_SSL=true with field descriptions. - docs/getting-started.md: VERIFY_SSL default to true; urllib3 disable_warnings now passes the specific InsecureRequestWarning. - docs/index.md: quick example uses verify=True; removed RTD link (RTD config was removed in this release because the build never worked). 2026-05-19T02:35:08+00:00 Roberto Bertó 463349+robertoberto@users.noreply.github.com 2026-05-19T02:35:08+00:00 urn:sha1:ea8c349f6dce955696850198b8544d0203b467fb This commit modernizes the project's tooling and packaging without changing the runtime code. It addresses dead workflows, obsolete helper scripts, duplicated configuration, and stale developer docs. Removed: - .github/workflows/python-app.yml: targeted Python 3.12, referenced a non-existent requirements.txt, ran only flake8 with pytest commented out - Makefile: hard-coded env/bin/python paths that do not work with uv - run_tests.sh and run_tests.py: duplicated each other and referenced removed modules (test_exceptions, test_quick) - sphinx/ and .readthedocs.yaml: the RTD config pointed to docs/source/conf.py while the sphinx tree lived under sphinx/source, so the build never worked and no docs were ever published - docs/development/architecture.md, refactor-roadmap.md, and quality-and-utils.md: described the pre-cleanup proposal that included specs/exceptions/request_id, now contradicted by the code Edited: - pyproject.toml: - dropped the validation extra (Pydantic) — specs/ is gone - dropped the duplicated [tool.hatch.metadata].dependencies block - dropped the duplicated [dependency-groups].dev block - declared the wheel package explicitly via [tool.hatch.build.targets.wheel].packages - bumped pytest floor to >=8.0 (Python 3.13 compatible) - added richer classifiers (Development Status, audience, topic, Typing :: Typed), keywords, license file pointer, and a Changelog URL - .github/workflows/python-pr-validation.yml: upgraded to actions/checkout@v4 and setup-python@v5, switched to astral-sh/setup-uv, removed obsolete architecture argument - .github/dependabot.yml: added the github-actions ecosystem so workflow versions stay current Added: - pyvyos/py.typed: PEP 561 marker advertising the package as typed - .pre-commit-config.yaml: neutral hooks only (whitespace, EOF, YAML/TOML syntax, large-file guard); no formatters or linters yet Kept: - docs/development/vyos_api/: JSON reference for the VyOS HTTPS API, useful for future contract tests Tests still pass: 57/57. 2025-11-02T22:54:44+00:00 roberto berto rberto@deepcausa.com 2025-11-02T22:54:44+00:00 urn:sha1:6b4e9015744ab8c9f17a6b8e23387cd676b1d827 - Fixed #25: config_file_save/load now include path: [] in payload - Added exception hierarchy (SDKError, HttpError, ApiError, ValidationError) - Added utility functions (json, ids, paths) - Added structured logging with request ID tracking - Added optional Pydantic validation models - Refactored to pyvyos.core.* structure with backward compatibility shims - Moved JSON specs to docs/development/vyos_api/ - Added comprehensive test suite (19 shim tests, 16 utils tests, 6 exception tests) - Updated pyproject.toml for uv sync editable installation - Added development documentation (architecture, roadmap, quality guidelines) Maintains 100% backward compatibility with 0.3.0 2025-08-29T17:00:39+00:00 eduardormorais eduardoromorais@gmail.com 2025-08-29T17:00:39+00:00 urn:sha1:33cbb56d994a523c5a68f037aed0912fea08fa4d 2025-08-28T21:01:24+00:00 eduardormorais eduardoromorais@gmail.com 2025-08-28T21:01:24+00:00 urn:sha1:7b147d6964e6390a93b069c6cc2a06bdc2c7651f 2024-03-10T22:33:08+00:00 Roberto Berto roberto.berto@under.com.br 2024-03-10T22:33:08+00:00 urn:sha1:aeeced363ffe72c2a37bf77fb7a367891599054c 2023-12-13T17:33:47+00:00 Roberto Berto roberto.berto@gmail.com 2023-12-13T17:33:47+00:00 urn:sha1:292ddfd8205bc09fe7a657b58e1408855dd504e6 2023-12-13T17:31:35+00:00 Roberto Berto roberto.berto@gmail.com 2023-12-13T17:31:35+00:00 urn:sha1:a7b3027c86464046e6dbd266d0d796d55591806e