diff options
| author | Robert Göhler <github@ghlr.de> | 2024-03-10 20:58:42 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-10 20:58:42 +0100 |
| commit | 0d37526d22519b7234ccc8023c23ece37e49929c (patch) | |
| tree | 1a730594696746b83184090428ffd8a04421fedc /docs/automation/vyos-pyvyos.rst | |
| parent | c5cab86ea6828c8cd2323bd43f672d52713859b4 (diff) | |
| parent | aadc27ceb26cba295310e1632ee19cf42a3aec77 (diff) | |
| download | vyos-documentation-0d37526d22519b7234ccc8023c23ece37e49929c.tar.gz vyos-documentation-0d37526d22519b7234ccc8023c23ece37e49929c.zip | |
Merge pull request #1321 from robertoberto/master
renamed to pyvyos instead of PyVyOS and fixed rST syntax
Diffstat (limited to 'docs/automation/vyos-pyvyos.rst')
| -rw-r--r-- | docs/automation/vyos-pyvyos.rst | 28 |
1 files changed, 18 insertions, 10 deletions
diff --git a/docs/automation/vyos-pyvyos.rst b/docs/automation/vyos-pyvyos.rst index fba9b8b7..948534f8 100644 --- a/docs/automation/vyos-pyvyos.rst +++ b/docs/automation/vyos-pyvyos.rst @@ -1,20 +1,28 @@ -: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 +69,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 +153,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 |