Merge pull request #14 from SPOpenSource/release/0.15.2-a1

Release/0.15.2 a1

Author: zachcamara-hpe

.gitignore

@@ -25,8 +25,14 @@ wheels/
 .installed.cfg
 *.egg
 
-# Tests & Documentation
-tests/
+# Dev
+.vscode
+
+# Tests
+tests/dev
+.tox
+
+# Documentation
 docs/build/
 docs/source/_build
 examples/generate_preconfig/preconfig_outputs

MANIFEST.in

@@ -1,7 +1,7 @@
 exclude *.nix
 exclude .pre-commit-config.yaml
 include *.py
-include testing/*.py
+include tests/test*.py
 include tox.ini
 include *.md
 include LICENSE

_version.py

@@ -1 +1 @@
-version = "0.15.1a1.dev0"
+version = "0.15.1a2.dev28"

docs/source/conf.py

@@ -16,7 +16,7 @@
 # Main version number
 version = "0.15"
 # The full version, including alpha/beta/rc tags
-release = "0.15.1-a1"
+release = "0.15.2-a1"
 
 
 # -- General configuration ---------------------------------------------------

docs/source/examples/generate_preconfig.rst

@@ -3,12 +3,19 @@
 
 .. important::
 
-    The following example is more complex code than the other examples,
+    The following example is more complex code than the general examples,
     generating data and interacting with Orchestrator. Using and
     modifying these examples requires a greater understanding of python
     functions, handling variables, and additional tools such as Jinja.
 
 
+.. note::
+
+    The code referenced in this document and all published examples
+    with pyedgeconnect are available from the GitHub repository within the
+    `examples <https://https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
+    folder
+
 Generate EdgeConnect Preconfig
 ------------------------------
 
@@ -154,17 +161,19 @@ Additional availble runtime arguments are as follows:
 - ``-o`` or ``--orch``
     - Type: String
     - Desc: Specify the Orchestrator IP or FQDN
-    - Example values: ``10.100.1.90`` or ``orchestrator.<company>.com``
+    - Example values: ``192.0.2.100`` or ``orchestrator.<company>.com``
     - Default value: ``None``
 - ``-u`` or ``--upload``
     - Type: Boolean
-    - Desc: Upload the rendered YAML preconfig to Orchestrator
-    - Accepted values: ``True`` or ``False``
+    - Desc: Upload the rendered YAML preconfig to Orchestrator.
+      Including the ``-u`` will translate to ``True``, no option will
+      default to ``False``
     - Default value: ``False``
 - ``-aa`` or ``--autoapply``
     - Type: Boolean
-    - Desc: Auto-apply the YAML preconfig on Orchestrator to a discovered appliance
-    - Accepted values: ``True`` or ``False``
+    - Desc: Auto-apply the YAML preconfig on Orchestrator to a
+      discovered appliance. Including the ``-aa`` will translate to
+      ``True``, no option will default to ``False``
     - Default value: ``False``
 - ``-j`` or ``--jinja``
     - Type: String
@@ -209,7 +218,8 @@ Orchestrator API calls
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The two API calls to Orchestrator (outside of authentication) are
-``validate_preconfig`` and ``create_preconfig``.
+:func:`pyedgeconnect.Orchestrator.validate_preconfig` and
+:func:`pyedgeconnect.Orchestrator.create_preconfig`.
 
 The ``validate_preconfig`` function sends the preconfig YAML text to
 Orchestrator and will either return a success (HTTP 200 OK) or if

docs/source/examples/index.rst

@@ -3,8 +3,10 @@ Example Code from Repository
 ============================
 
 All examples documented in this section are available from the
-GitHub repository within the ``examples`` folder:
-https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples
+GitHub repository within the
+`examples <https://https://github.com/SPOpenSource/edgeconnect-python/tree/main/examples>`_
+folder:
+
 
 Example script documentation and instructions
 
@@ -13,4 +15,5 @@ Example script documentation and instructions
 
    auth_example
    basic_examples
-   generate_preconfig
+   generate_preconfig
+   upload_security_policy