diff options
| author | Roberto Bertó <463349+robertoberto@users.noreply.github.com> | 2025-11-02 19:55:55 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-11-02 19:55:55 -0300 |
| commit | 6ca1269b138696b69c33d2db4bcf7dd03ea4caeb (patch) | |
| tree | 4c0a634730df2123ff506252cbec050de006dac8 /docs/index.md | |
| parent | 1ada32975f0bb559ec7526e0dd545700dde1cb94 (diff) | |
| parent | 6b4e9015744ab8c9f17a6b8e23387cd676b1d827 (diff) | |
| download | pyvyos-6ca1269b138696b69c33d2db4bcf7dd03ea4caeb.tar.gz pyvyos-6ca1269b138696b69c33d2db4bcf7dd03ea4caeb.zip | |
Merge pull request #27 from vyos-contrib/feat/architecture-and-quality-improvements
feat: v0.4.0 - Architecture refactor, bug fixes, and quality improvem…
Diffstat (limited to 'docs/index.md')
| -rw-r--r-- | docs/index.md | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..1bc9cb7 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,56 @@ +# PyVyOS Documentation + +PyVyOS is a Python SDK for interacting with VyOS devices via their REST API. This library provides a simple and intuitive interface to manage VyOS network devices programmatically. + +## Overview + +PyVyOS enables developers to: +- Configure VyOS devices remotely +- Retrieve configuration and operational data +- Manage system operations (reboot, poweroff) +- Generate SSH keys and manage images +- Save and load configuration files + +## Documentation Structure + +- [Installation](installation.md) - How to install PyVyOS +- [Getting Started](getting-started.md) - Quick start guide +- [API Reference](api-reference.md) - Complete API documentation +- [Configuration](configuration.md) - Device setup and authentication +- [Examples](examples.md) - Common usage patterns +- [Concepts](concepts.md) - Key concepts and architecture +- [Troubleshooting](troubleshooting.md) - Common issues and solutions + +## Requirements + +- Python 3.13 or higher +- VyOS device with REST API enabled +- API key for authentication + +## Quick Example + +```python +from pyvyos import VyDevice + +device = VyDevice( + hostname="192.168.1.1", + apikey="your-api-key", + port=443, + protocol="https", + verify=False +) + +response = device.show(path=["system", "image"]) +print(response.result) +``` + +## Resources + +- [GitHub Repository](https://github.com/vyos-contrib/pyvyos) +- [PyPI Package](https://pypi.org/project/pyvyos/) +- [Read the Docs](https://pyvyos.readthedocs.io/) + +## License + +MIT License - See LICENSE file for details + |