diff options
| author | Roberto Bertó <roberto.berto@gmail.com> | 2024-03-10 12:49:59 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-10 12:49:59 -0300 |
| commit | c7e3be335588d8b236aae520cd36fab8d874d471 (patch) | |
| tree | 53025589ffb1113ec243d14b996093d28e3488f6 /docs | |
| parent | 95878ef8c96e276a8bc09b0326878a654ce2ee58 (diff) | |
| download | vyos-documentation-c7e3be335588d8b236aae520cd36fab8d874d471.tar.gz vyos-documentation-c7e3be335588d8b236aae520cd36fab8d874d471.zip | |
Update vyos-pyvyos.rst
renamed to pyvyos instead of PyVyOS and fixed rST syntax
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/automation/vyos-pyvyos.rst | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/docs/automation/vyos-pyvyos.rst b/docs/automation/vyos-pyvyos.rst index fba9b8b7..edc1f7fe 100644 --- a/docs/automation/vyos-pyvyos.rst +++ b/docs/automation/vyos-pyvyos.rst @@ -1,20 +1,21 @@ -:lastproofread: 2023-12-15 +:lastproofread: 2024-03-10 .. _vyos-pyvyos: -PyVyOS +pyvyos ====== -PyVyOS is a Python library for interacting with VyOS devices via their API. -This documentation guides you on using PyVyOS to manage your VyOS devices programmatically. -The complete PyVyOS documentation is available on [Read the Docs](https://pyvyos.readthedocs.io/en/latest/), -and the library can be found on [GitHub](https://github.com/robertoberto/pyvyos) -and [PyPI](https://pypi.org/project/pyvyos/). +pyvyos is a Python library designed for interacting with VyOS devices through their API. +This documentation is intended to guide you in using pyvyos for programmatic management of your VyOS devices. + +- `pyvyos Documentation on Read the Docs <https://pyvyos.readthedocs.io/en/latest/>`_ provides detailed instructions on the installation, configuration, and operation of the pyvyos library. +- `pyvyos Source Code on GitHub <https://github.com/robertoberto/pyvyos>`_ allows you to access and contribute to the library's code. +- `pyvyos on PyPI <https://pypi.org/project/pyvyos/>`_ for easy installation via pip, the Python package installer. Execute `pip install pyvyos` in your terminal to install. Installation ------------ -You can install PyVyOS using pip: +You can install pyvyos using pip: .. code-block:: bash @@ -61,7 +62,7 @@ Initializing a VyDevice Object device = VyDevice(hostname=hostname, apikey=apikey, port=port, protocol=protocol, verify=verify) -Using PyVyOS +Using pyvyos ------------ Configure, then Set @@ -145,4 +146,4 @@ Configure, then Load File response = device.config_file_load(file="/config/test300.config") -.. _pyvyos: https://github.com/robertoberto/pyvyos
\ No newline at end of file +.. _pyvyos: https://github.com/robertoberto/pyvyos |