Merge pull request #16 from SPOpenSource/release/0.15.3-a1

Release/0.15.3 a1

.gitignore

@@ -24,22 +24,31 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+_version.py
 
 # Dev
 .vscode
 
 # Tests
-tests/dev
 .tox
 
 # Documentation
 docs/build/
 docs/source/_build
-examples/generate_preconfig/preconfig_outputs
 
 # dotenv
 *.env
 
+# Code Examples
+examples/generate_preconfig/preconfig_outputs
+examples/edgeconnect-telemetry-demo/app/grafana/data
+examples/edgeconnect-telemetry-demo/app/influxdb/data
+examples/edgeconnect-telemetry-demo/app/influxdb/config
+examples/edgeconnect-telemetry-demo/app/redis
+examples/edgeconnect-telemetry-demo/app/worker
+examples/edgeconnect-telemetry-demo/app/logging/
+!example.env
+
 # Virtual Environment
 .venv/
 

_version.py

@@ -1 +1 @@
-version = "0.15.2a2.dev0"
+version = "0.15.3a1.dev0"

docs/source/_static/css/pyedgeconnect.css

@@ -0,0 +1,143 @@
+/* Nav Search Background */
+.wy-side-nav-search {
+    background-color: #FF8300
+}
+
+.wy-side-nav-search .wy-dropdown>a img.logo,
+.wy-side-nav-search>a img.logo {
+    width: 125px;
+}
+
+/* Menu Title Color */
+.wy-menu-vertical p.caption {
+    color: #FF8300;
+}
+
+/* Content background */
+.wy-nav-content {
+    margin: 0;
+    background: #0F3250;
+}
+
+/* Outer background */
+.wy-nav-content-wrap {
+    background: #343131;
+}
+
+/* Body Text Color */
+body {
+    color: #dbdce1;
+}
+
+dd {
+    display: block;
+    margin-inline-start: 0px;
+}
+
+/* Header Text Color */
+.rst-content .toctree-wrapper>p.caption,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+legend {
+    color: #FFFFFF;
+}
+
+/* Notes, Warnings, Important Colors */
+.rst-content .note .admonition-title {
+    background: rgba(53, 139, 193, 1)
+}
+
+.rst-content .note {
+    background: rgba(53, 139, 193, 0.5)
+}
+
+.rst-content .warning .admonition-title {
+    background: rgba(193, 53, 53, 1)
+}
+
+.rst-content .warning {
+    background: rgba(193, 53, 53, 0.5)
+}
+
+.rst-content .important .admonition-title {
+    background: rgba(255, 131, 0, 1)
+}
+
+.rst-content .important {
+    background: rgba(255, 131, 0, 0.7)
+}
+
+
+/* Code Highlight */
+.highlight {
+    color: #ADE1F0;
+    background: #04121e;
+}
+
+.highlight .s1 {
+    color: #FF8300;
+}
+
+.highlight .s2 {
+    color: #FF8300;
+}
+
+.highlight .sd {
+    color: #FF8300;
+}
+
+.rst-content div[class^=highlight],
+.rst-content pre.literal-block {
+    border: none
+}
+
+
+.rst-content code.literal,
+.rst-content tt.literal {
+    color: #ADE1F0;
+    background: #04121e;
+    border: none;
+}
+
+.rst-content code.xref,
+.rst-content tt.xref,
+a .rst-content code,
+a .rst-content tt {
+    font-weight: 900;
+}
+
+
+/* Table Text */
+.rst-content table.docutils caption,
+.rst-content table.field-list caption,
+.wy-table caption {
+    color: #ADE1F0;
+}
+
+.rst-content table.docutils thead,
+.rst-content table.field-list thead,
+.wy-table thead {
+    color: #ADE1F0;
+}
+
+.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,
+.wy-table-backed,
+.wy-table-odd td,
+.wy-table-striped tr:nth-child(2n-1) td {
+    background-color: #184369;
+}
+
+/* Module Content */
+
+html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descname,
+html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .sig-name {
+    color: #0F3250;
+}
+
+strong {
+    color: #ADE1F0;
+}

docs/source/conf.py

@@ -1,5 +1,5 @@
 # Configuration file for the Sphinx documentation builder.
-#
+
 import os
 import sys
 
@@ -16,15 +16,20 @@
 # Main version number
 version = "0.15"
 # The full version, including alpha/beta/rc tags
-release = "0.15.2-a1"
+release = "0.15.3-a1"
 
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.todo", "sphinx.ext.viewcode", "sphinx.ext.autodoc"]
+extensions = [
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -40,10 +45,15 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-# html_theme = 'alabaster'
 html_theme = "sphinx_rtd_theme"
+html_logo = "_static/aruba_small_use_logo.png"
+
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+
+
+def setup(app):
+    app.add_css_file("css/pyedgeconnect.css")

docs/source/examples/auth_example.rst

@@ -1,15 +1,28 @@
 .. auth_example:
 
-============================
- Authentication
-============================
+
+Authentication
+********************************
 
 The following code snippet is an example of handling multiple authentication
 methods when connecting to an Aruba Orchestrator instance with pyedgeconnect.
 
 The example scripts provided in the repository use this process in
 addition to any other required logic for a particular use-case.
 
+.. note::
+
+    The code referenced in this document and all published examples
+    with pyedgeconnect are available from the GitHub repository within the
+    `examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
+    folder. Each example script contains logic to authenticate to the
+    Orchestrator as documented in the authentication example.
+
+    Clone the repository and download the examples with:
+
+    .. code:: bash
+
+        $ git clone https://github.com/SPOpenSource/edgeconnect-python.git
 
 
 Environment variables
@@ -23,12 +36,12 @@ related to authenticating to Orchestrator
 ``ORCH_USER``
 ``ORCH_PASSWORD``
 
-If ORCH_URL is specified, it will take precedence, otherwise user will
-be prompted for input to enter the Orchestrator IP or FQDN
+If ``ORCH_URL`` is specified, it will take precedence, otherwise user
+will be prompted for input to enter the Orchestrator IP or FQDN
 
-If ORCH_API_KEY is specified it will take precedence for an authentication
-method over user/password authentication. If not found, the user will be
-prompted for entering an API key.
+If ``ORCH_API_KEY`` is specified it will take precedence for an
+authentication method over user/password authentication. If not found,
+the user will be prompted for entering an API key.
 
 .. code-block:: python
 

docs/source/examples/basic_examples.rst

@@ -1,14 +1,23 @@
 .. basic_examples:
 
 
-The following examples are also included as individual .py files in the
-repository in the `examples` directory. Each example script contains
-logic to authenticate to the Orchestrator as documented in the
-authentication example.
+.. note::
+
+    The code referenced in this document and all published examples
+    with pyedgeconnect are available from the GitHub repository within the
+    `examples <https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
+    folder. Each example script contains logic to authenticate to the
+    Orchestrator as documented in the authentication example.
+
+    Clone the repository and download the examples with:
+
+    .. code:: bash
+
+        $ git clone https://github.com/SPOpenSource/edgeconnect-python.git
 
 
 Print Appliance Information
-===========================
+------------------------------
 
 This example retrieves all the appliances currently in Orchestrator
 and then prints the appliances and certain attributes into a table in
@@ -80,7 +89,7 @@ the terminal output.
 
 
 Run Packet Capture
-==================
+-----------------------
 
 This example will run a tcpdump packet capture on the specified
 appliance and then upload the file to Orchestrator so that it can be
@@ -149,8 +158,8 @@ downloaded by the user or uploaded to support.
         pass
 
 
-Create User
-==================
+Create Local Orchestrator User
+--------------------------------
 
 This example will create a new user read-only user
 locally on Orchestrator.