diff options
| author | Roberto Bertó <463349+robertoberto@users.noreply.github.com> | 2026-05-19 02:54:59 +0000 |
|---|---|---|
| committer | Roberto Bertó <463349+robertoberto@users.noreply.github.com> | 2026-05-19 02:54:59 +0000 |
| commit | a2df70609a4711b4eb673f28cee3e6f72414148a (patch) | |
| tree | 972f05e70f17ddbe0337c4e2cc48797475131413 /README.md | |
| parent | bf4e309a698592cdb815580f97db97b268fd6668 (diff) | |
| download | pyvyos-a2df70609a4711b4eb673f28cee3e6f72414148a.tar.gz pyvyos-a2df70609a4711b4eb673f28cee3e6f72414148a.zip | |
chore: trim root, move examples, drop committed uv.lock
- 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
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 5 |
1 files changed, 5 insertions, 0 deletions
@@ -171,6 +171,11 @@ The deprecation timeline is: | `0.6.x` | Compatibility shims emit a `DeprecationWarning`. | | `1.0.0` | Shims are removed or kept, depending on observed usage. | +## Examples + +A runnable end-to-end example lives in [`examples/basic.py`](examples/basic.py), +and a Vagrant-based lab setup under [`examples/vagrant/`](examples/vagrant/). + ## Logging `pyvyos` uses the standard `logging` module under the `pyvyos` namespace and |