Merge branch 'release/5.1.0'

Author: qrkourier

.github/workflows/mattermost-ziti-webhook.yml

@@ -0,0 +1,23 @@
+name: mattermost-ziti-webhook
+on: 
+  create:
+  delete:
+  issues:
+  issue_comment:
+  pull_request_review:
+  pull_request_review_comment:
+  pull_request:
+  push:
+  fork:
+  release:
+
+jobs:
+  mattermost-ziti-webhook:
+    runs-on: macos-latest
+    name: POST Webhook
+    steps:
+    - uses: openziti/ziti-webhook-action@main
+      with:
+        ziti-id: ${{ secrets.ZITI_MATTERMOST_IDENTITY }}
+        webhook-url: ${{ secrets.ZITI_MATTERMOST_WEBHOOK_URL }}
+        webhook-secret: ${{ secrets.ZITI_MATTERMOSTI_WEBHOOK_SECRET }}

.github/workflows/python-publish.yml

@@ -0,0 +1,36 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -10,8 +10,7 @@ This creates a demo network named "BibbidiBobbidiBoo" with your API account stor
 Learn about getting an API account by reading the [Authentication Guide](https://developer.netfoundry.io/v2/guides/authentication/)
 
 ```bash
-$ python3 -m netfoundry.demo BibbidiBobbidiBoo
-INFO: running demo script in /home/alice/.pyenv/versions/3.9.0/lib/python3.9/site-packages/netfoundry/demo.py
+python3 -m netfoundry.demo --network=BibbidiBobbidiBoo
 ```
 
 ## Create network snippet from demo.py
@@ -20,15 +19,15 @@ INFO: running demo script in /home/alice/.pyenv/versions/3.9.0/lib/python3.9/sit
 #!/usr/bin/env python3
 import netfoundry
 
-# default API account credential file is ~/.netfoundry/credentials.json
-Organization = netfoundry.Organization(credentials="credentials.json")
+# user-default path is ~/.netfoundry/
+organization = netfoundry.Organization(credentials="credentials.json")
 
 # use some Network Group, default is to use the first and there's typically only one
-network_group = netfoundry.NetworkGroup(Organization)
+network_group = netfoundry.NetworkGroup(organization)
 
 # create a Network
 network_name = "BibbidiBobbidiBoo"
-if network_name in network_group.networks_by_name.keys():
+if network_name in network_group.networks_by_name().keys():
     # use the Network
     network = netfoundry.Network(network_group, network_name=network_name)
     network.wait_for_status("PROVISIONED",wait=999,progress=True)

netfoundry/demo.py

@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
-r"""Example script to create a NetFoundry Network
+r"""Use this script to create a network with functioning services and demonstrate the NetFoundry Python module.
+
 Usage::
-    $ python3 -m netfoundry.demo BibbidiBobbidiBoo
+    $ python3 -m netfoundry.demo --network BibbidiBobbidiBoo
 """
 
 import argparse
@@ -14,7 +15,7 @@
 
 
 def main():
-
+    """Run the demo script."""
     print("DEBUG: running demo script in \"{:s}\"".format(sys.argv[0]))
 
     parser = argparse.ArgumentParser()
@@ -31,7 +32,7 @@ def main():
     )
     parser.add_argument(
         "-o", "--organization",
-        help="The label of an alternative Organization (default is Org of caller)"
+        help="The label of an alternative organization (default is Org of caller)"
     )
     parser.add_argument(
         "-g", "--network-group",
@@ -96,16 +97,16 @@ def main():
 
     network_name = args.network
 
-    # use the session with some Organization, default is to use the first and there's typically only one
-    Organization = netfoundry.Organization(
+    # use the session with some organization, default is to use the first and there's typically only one
+    organization = netfoundry.Organization(
         credentials=args.credentials if 'credentials' in args else None,
         organization_label=args.organization if 'organization' in args else None,
         proxy=args.proxy
     )
 
     # use some Network Group, default is to use the first and there's typically only one
     network_group = netfoundry.NetworkGroup(
-        Organization,
+        organization,
         network_group_name=args.network_group if 'network_group' in args else None
     )