Merge branch 'release-v5.8.18'

Author: qrkourier

README.md

@@ -1,3 +1,6 @@
+# NetFoundry Python Module
+
+This module has a general-purpose library for using the NetFoundry API and installs the CLI `nfctl`.
 
 ## User Guide
 
@@ -6,18 +9,19 @@
 ## Find the Version
 
 ```bash
-$ python3 -m netfoundry.version
+ $ python3 -m netfoundry.version
+v5.2.0
+ # or
+ $ nfctl version
 v5.2.0
 ```
 
 ## Play the demo
 
-This creates a demo network named "BibbidiBobbidiBoo" with your API account stored in ~/.netfoundry/credentials.json
-
-Learn about getting an API account by reading the [Authentication Guide](https://developer.netfoundry.io/v2/guides/authentication/)
+This creates a demo network with your API account file named `credentials.json` stored in the current directory or the XDG config directory e.g. `~/.config/netfoundry/`. Learn how to obtain and use an API account for your NetFoundry organization in [the Authentication Guide](https://developer.netfoundry.io/guides/authentication/)
 
 ```bash
-python3 -m netfoundry.demo --network=BibbidiBobbidiBoo
+nfctl demo
 ```
 
 ## Create network snippet from demo.py
@@ -29,19 +33,19 @@ import netfoundry
 # 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
+# use some network group, default is to use the first and there's typically only one
 network_group = netfoundry.NetworkGroup(organization)
 
-# create a Network
+# create a network
 network_name = "BibbidiBobbidiBoo"
-if network_name in network_group.networks_by_name().keys():
-    # use the Network
+if network_group.network_exists(network_name):
+    # use the network
     network = netfoundry.Network(network_group, network_name=network_name)
-    network.wait_for_status("PROVISIONED",wait=999,progress=True)
+    network.wait_for_status("PROVISIONED")
 else:
     network_id = network_group.create_network(name=network_name)['id']
     network = netfoundry.Network(network_group, network_id=network_id)
-    network.wait_for_status("PROVISIONED",wait=999,progress=True)
+    network.wait_for_status("PROVISIONED")
 ```
 
 ## Publish a new version of the module
@@ -65,4 +69,4 @@ else:
 12:00 Verify Published Artifacts in PyPi and Hub
 12:30 PyPi Upgrade Gets New Version
 13:30 Docker Run Check Version
-```
+```

netfoundry/ctl.py

@@ -1174,7 +1174,7 @@ def use_network_group(cli, organization: object, group: str = None, spinner: obj
     with spinner:
         network_group = NetworkGroup(
             organization,
-            group=group if group else None,
+            group=group,
         )
     spinner.succeed(f"Configured network group '{network_group.name}'")
     cli.log.debug(f"network group is {network_group.name}")

netfoundry/utility.py

@@ -393,8 +393,13 @@ def find_generic_resources(url: str, headers: dict, embedded: str = None, proxie
             yield yield_page
 
             # then yield subsequent pages, if applicable
-            if get_all_pages:         # this is False if param 'page' or 'size' to stop recursion or get a single page
-                for next_page in range(1, total_pages):  # first page is 0
+            if get_all_pages:           # this is False if param 'page' or 'size' to stop recursion or get a single page
+                if resource_type.name == 'network-groups':
+                    params['page'] = 1  # workaround API bug https://netfoundry.atlassian.net/browse/MOP-17890
+                    next_range_lower, next_range_upper = params['page'] + 2, total_pages + 1
+                else:
+                    next_range_lower, next_range_upper = params['page'] + 1, total_pages
+                for next_page in range(next_range_lower, next_range_upper):  # first page is 0 unless network-groups which are 1-based
                     params['page'] = next_page
                     try:
                         # recurse