Merge pull request #31 from vyos-contrib/release/v0.4.0-cleanupv0.4.0

Release v0.4.0 — cleanup and consolidation

7 files changed, 0 insertions, 355 deletions

diff --git a/sphinx/Makefile b/sphinx/Makefile
deleted file mode 100644
index d0c3cbf..0000000
--- a/sphinx/Makefile
+++ /dev/null
@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/sphinx/README.md b/sphinx/README.md
deleted file mode 100644
index 813f05d..0000000
--- a/sphinx/README.md
+++ /dev/null
@@ -1,27 +0,0 @@
-# Sphinx Documentation Builder
-
-This directory contains the Sphinx configuration for generating API documentation from Python docstrings.
-
-## Building Documentation
-
-To build the HTML documentation:
-
-```bash
-cd sphinx
-make html
-```
-
-The generated documentation will be in `sphinx/build/html/`.
-
-## Requirements
-
-Install Sphinx dependencies:
-
-```bash
-pip install -r sphinx/requirements.txt
-```
-
-## Read the Docs
-
-This configuration is used by Read the Docs for automated documentation builds.
-
diff --git a/sphinx/make.bat b/sphinx/make.bat
deleted file mode 100644
index 747ffb7..0000000
--- a/sphinx/make.bat
+++ /dev/null
@@ -1,35 +0,0 @@
-@ECHO OFF

-

-pushd %~dp0

-

-REM Command file for Sphinx documentation

-

-if "%SPHINXBUILD%" == "" (

-	set SPHINXBUILD=sphinx-build

-)

-set SOURCEDIR=source

-set BUILDDIR=build

-

-%SPHINXBUILD% >NUL 2>NUL

-if errorlevel 9009 (

-	echo.

-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx

-	echo.installed, then set the SPHINXBUILD environment variable to point

-	echo.to the full path of the 'sphinx-build' executable. Alternatively you

-	echo.may add the Sphinx directory to PATH.

-	echo.

-	echo.If you don't have Sphinx installed, grab it from

-	echo.https://www.sphinx-doc.org/

-	exit /b 1

-)

-

-if "%1" == "" goto help

-

-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

-goto end

-

-:help

-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

-

-:end

-popd

diff --git a/sphinx/requirements.txt b/sphinx/requirements.txt
deleted file mode 100644
index f1ce7d3..0000000
--- a/sphinx/requirements.txt
+++ /dev/null
@@ -1,2 +0,0 @@
-Sphinx>=7.2.6
-sphinx-rtd-theme>=2.0.0
diff --git a/sphinx/source/conf.py b/sphinx/source/conf.py
deleted file mode 100644
index ff95b65..0000000
--- a/sphinx/source/conf.py
+++ /dev/null
@@ -1,36 +0,0 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
-project = "pyvyos"
-copyright = "2024, Roberto Berto"
-author = "Roberto Berto"
-release = "0.3.0"
-
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-templates_path = ["_templates"]
-exclude_patterns = []
-
-
-# -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
-html_theme = "sphinx_rtd_theme"
-html_static_path = ["_static"]
-
-
-import os
-import sys
-
-sys.path.insert(0, os.path.abspath("../../"))
-
-extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx_rtd_theme",
-]
diff --git a/sphinx/source/index.rst b/sphinx/source/index.rst
deleted file mode 100644
index 05c2aa0..0000000
--- a/sphinx/source/index.rst
+++ /dev/null
@@ -1,214 +0,0 @@
-.. PyVyOS documentation master file, created by
-   sphinx-quickstart on Wed Dec 13 13:02:59 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-PyVyOS - documentation
-==================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-pyvyos
-======
-
-.. toctree::
-   :maxdepth: 4
-
-   pyvyos
-   
-PyVyOS Usage
-==================
-
-.. _pyvyos-documentation:
-
-PyVyOS Documentation
-====================
-
-PyVyOS is a Python library for interacting with VyOS devices via their API. This documentation provides a guide on how to use PyVyOS to manage your VyOS devices programmatically.
-
-Installation
-------------
-
-You can install PyVyOS using pip:
-
-.. code-block:: bash
-
-   pip install pyvyos
-
-Getting Started
----------------
-
-Importing and Disabling Warnings for verify=False
---------------------------------------------------
-
-Before using PyVyOS, it's a good practice to disable urllib3 warnings and import the required modules, IF you use verify=False:
-
-.. code-block:: python
-
-   import urllib3
-   urllib3.disable_warnings()
-
-Using API Response Class
-------------------------
-
-PyVyOS uses a custom `ApiResponse` data class to handle API responses:
-
-.. code-block:: python
-
-   @dataclass
-   class ApiResponse:
-       status: int
-       request: dict
-       result: dict
-       error: str
-
-Initializing a VyDevice Object
-------------------------------
-
-To interact with your VyOS device, you'll need to create an instance of the `VyDevice` class. You can set up your device using the following code, assuming you've stored your credentials as environment variables:
-
-.. code-block:: python
-
-   from dotenv import load_dotenv
-
-   # Load environment variables from a .env file
-   load_dotenv()
-
-   # Retrieve VyOS device connection details from environment variables
-   hostname = os.getenv('VYDEVICE_HOSTNAME')
-   apikey = os.getenv('VYDEVICE_APIKEY')
-   port = os.getenv('VYDEVICE_PORT')
-   protocol = os.getenv('VYDEVICE_PROTOCOL')
-   verify_ssl = os.getenv('VYDEVICE_VERIFY_SSL')
-
-   # Convert the verify_ssl value to a boolean
-   verify = verify_ssl.lower() == "true" if verify_ssl else True
-
-   # Create an instance of the VyOS device
-   device = VyDevice(hostname=hostname, apikey=apikey, port=port, protocol=protocol, verify=verify)
-
-Using PyVyOS
-------------
-
-Once you have created a VyDevice object, you can use it to interact with your VyOS device using various methods provided by the library.
-
-Reset
------
-
-The reset method allows you to run a reset command:
-
-.. code-block:: python
-
-   # Execute the reset command
-   response = device.reset(path=["conntrack-sync", "internal-cache"])
-
-   # Check for errors and print the result
-   if not response.error:
-       print(response.result)
-
-Retrieve Show Configuration
----------------------------
-
-The retrieve_show_config method retrieves the VyOS configuration:
-
-.. code-block:: python
-
-   # Retrieve the VyOS configuration
-   response = device.retrieve_show_config(path=[])
-
-   # Check for errors and print the result
-   if not response.error:
-       print(response.result)
-
-Retrieve Return Values
------------------------- 
-
-.. code-block:: python
-
-   # Retrieve VyOS return values for a specific interface
-   response = device.retrieve_return_values(path=["interfaces", "dummy", "dum1", "address"])
-   print(response.result)
-
-Configure Delete
-----------------
-
-.. code-block:: python
-
-   # Delete a VyOS interface configuration
-   response = device.configure_delete(path=["interfaces", "dummy", "dum1"])
-
-Generate
-----------
-
-.. code-block:: python
-
-   # Generate an SSH key with a random string in the name
-   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])
-
-Show
-------
-
-.. code-block:: python
-
-   # Show VyOS system image information
-   response = device.show(path=["system", "image"])
-   print(response.result)
-
-Reset
-------
-
-.. code-block:: python
-
-   # Reset VyOS with specific parameters
-   response = device.reset(path=["conntrack-sync", "internal-cache"])
-
-Configure Set
--------------
-
-The configure_set method sets a VyOS configuration:
-
-.. code-block:: python
-
-   # Set a VyOS configuration
-   response = device.configure_set(path=["interfaces ethernet eth0 address '192.168.1.1/24'"])
-
-   # Check for errors and print the result
-   if not response.error:
-       print(response.result)
-
-Config File Save
-----------------
-
-.. code-block:: python
-
-   # Save VyOS configuration without specifying a file (default location)
-   response = device.config_file_save()
-
-Config File Save with custom filename
--------------------------------------
-
-.. code-block:: python
-
-   # Save VyOS configuration to a specific file
-   response = device.config_file_save(file="/config/test300.config")
-
-Config File Load
-----------------
-
-.. code-block:: python
-
-   # Load VyOS configuration from a specific file
-   response = device.config_file_load(file="/config/test300.config")
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
\ No newline at end of file
diff --git a/sphinx/source/pyvyos.rst b/sphinx/source/pyvyos.rst
deleted file mode 100644
index fc02f1a..0000000
--- a/sphinx/source/pyvyos.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-pyvyos package
-==============
-
-Submodules
-----------
-
-pyvyos.device module
---------------------
-
-.. automodule:: pyvyos.device
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: pyvyos
-   :members:
-   :undoc-members:
-   :show-inheritance: