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

1 files changed, 0 insertions, 113 deletions

diff --git a/example.py b/example.py
deleted file mode 100644
index e48983a..0000000
--- a/example.py
+++ /dev/null
@@ -1,113 +0,0 @@
-# importing modules
-import warnings
-
-warnings.filterwarnings("ignore", category=RuntimeWarning)
-import os
-
-# adding pyvyos to sys.path
-# sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__))))
-
-from dotenv import load_dotenv
-import pprint
-import random
-import string
-
-# importing pyvyos modules
-from pyvyos.device import VyDevice
-
-# getting env variables
-load_dotenv()
-hostname = os.getenv("VYDEVICE_HOSTNAME")
-apikey = os.getenv("VYDEVICE_APIKEY")
-port = os.getenv("VYDEVICE_PORT")
-protocol = os.getenv("VYDEVICE_PROTOCOL")
-verify = os.getenv("VYDEVICE_VERIFY_SSL")
-
-if verify == "False":
-    verify = False
-else:
-    verify = True
-
-# running example
-if __name__ == "__main__":
-    # preparing connection to vyos device
-    device = VyDevice(
-        hostname=hostname,
-        apikey=apikey,
-        port=port,
-        protocol=protocol,
-        verify=verify,
-        timeout=60,
-    )
-
-    response = device.retrieve_show_config(["system"])
-    pprint.pprint(response)
-    response = device.configure_set(
-        path=["interfaces", "dummy", "dum1", "address", "192.168.56.100/24"]
-    )
-    pprint.pprint(response)
-
-    response = device.retrieve_return_values(
-        path=["interfaces", "dummy", "dum1", "address"]
-    )
-    pprint.pprint(response)
-
-    response = device.configure_delete(path=["interfaces", "dummy", "dum1"])
-    pprint.pprint(response)
-
-    randstring = "".join(
-        random.choice(string.ascii_letters + string.digits) for _ in range(20)
-    )
-    keyrand = f"/tmp/key_{randstring}"
-    response = device.generate(path=["ssh", "client-key", keyrand])
-    pprint.pprint(response)
-
-    response = device.show(path=["system", "image"])
-    pprint.pprint(response)
-
-    response = device.reset(path=["conntrack-sync", "internal-cache"])
-    pprint.pprint(response)
-
-    response = device.config_file_save(file="/config/test300.config")
-    pprint.pprint(response)
-
-    response = device.config_file_load(file="/config/test300.config")
-    pprint.pprint(response)
-
-    response = device.configure_multiple_op(
-        op_path=[
-            {
-                "op": "set",
-                "path": ["interfaces", "dummy", "dum1", "address", "192.168.56.100/24"],
-            },
-            {
-                "op": "delete",
-                "path": ["interfaces", "dummy", "dum1"],
-            },
-        ]
-    )
-    pprint.pprint(response)
-
-    # print("### Generating ssh key ###")
-    # randstring = ''.join(random.choice(string.ascii_letters + string.digits) for _ in range(20))
-    # keyrand =  f'/tmp/key_{randstring}'
-    # response = device.generate(path=["ssh", "client-key", keyrand])
-    # pprint.pprint(response)
-
-    # response = device.retrieve_return_values(path=["interfaces", "ethernet", "eth0", "address"])
-    # pprint.pprint(response)
-
-    # response = device.reset(path=["conntrack-sync", "internal-cache"])
-    # pprint.pprint(response)
-
-    # response = device.reboot(path=["now"])
-    # pprint.pprint(response)
-
-    # response = device.shutdown(path=["now"])
-    # pprint.pprint(response)
-
-    # response = device.image_add(url="https://github.com/vyos/vyos-rolling-nightly-builds/releases/download/1.5-rolling-202312130023/vyos-1.5-rolling-202312130023-amd64.iso")
-    # pprint.pprint(response)
-
-    # response = device.image_delete(name="foo")
-    # pprint.pprint(response)