Updates after pull request

Author: dnichol

examples/update_usergroups_from_csv.py

@@ -2,6 +2,37 @@
 Created on Jan 27, 2023
 @author: dnichol
 Bulk update user group names from CSV.  CSV file requires two columns, titled 'Existing' and 'New'.  This script is case sensitive.
+
+This script requires a .restconfig.json file present to configure the connection details.  For more details see : https://community.synopsys.com/s/article/How-to-use-the-hub-rest-api-python-for-Black-Duck
+
+The .restconfig.json file should be in the following format:
+
+{
+   "baseurl": "https://your-hub-dns",
+   "api_token": "insert-token-here",
+   "insecure": true,
+   "debug": false
+}
+
+Copyright (C) 2023 Synopsys, Inc.
+http://www.synopsys.com/
+
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
 '''
 
 import csv
@@ -15,7 +46,6 @@
 from blackduck import Client
 
 def log_config():
-    # TODO: debug option in .restconfig file to be reflected
     logging.basicConfig(format='%(asctime)s:%(levelname)s:%(module)s: %(message)s', stream=sys.stderr, level=logging.DEBUG)
     logging.getLogger("requests").setLevel(logging.WARNING)
     logging.getLogger("urllib3").setLevel(logging.WARNING)
@@ -73,7 +103,7 @@ def update_user_group(hub_client, existing_name, new_name, user_group):
     # Update the name.
     user_group['name'] = new_name
 
-    logging.info(f"Updating user group {existing_name} to {user_group['name']} for user group {user_group_url}s")
+    logging.info(f"Updating user group {existing_name} to {user_group['name']} for user group {user_group_url}")
     hub_client.session.put(user_group_url, json=user_group)
 
 

examples/update_users_from_csv.py

@@ -2,6 +2,34 @@
 Created on Jan 27, 2023
 @author: dnichol
 Bulk update users email addresses from CSV.  CSV file requires two columns, titled 'Existing' and 'New'.  This script is case sensitive.
+
+This script requires a .restconfig.json file present to configure the connection details.  For more details see : https://community.synopsys.com/s/article/How-to-use-the-hub-rest-api-python-for-Black-Duck
+
+The .restconfig.json file should be in the following format:
+
+{
+   "baseurl": "https://your-hub-dns",
+   "api_token": "insert-token-here",
+   "insecure": true,
+   "debug": false
+}
+
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
 '''
 
 import csv
@@ -15,7 +43,6 @@
 from blackduck import Client
 
 def log_config():
-    # TODO: debug option in .restconfig file to be reflected
     logging.basicConfig(format='%(asctime)s:%(levelname)s:%(module)s: %(message)s', stream=sys.stderr, level=logging.DEBUG)
     logging.getLogger("requests").setLevel(logging.WARNING)
     logging.getLogger("urllib3").setLevel(logging.WARNING)
@@ -79,7 +106,7 @@ def update_user(hub_client, existing_email, new_email, user):
     if user.get('externalUserName') and user['externalUserName'] == existing_email:
         user['externalUserName'] = new_email
 
-    logging.info(f"Updating user {existing_email} to {user['email']} for user {user_url}s")
+    logging.info(f"Updating user {existing_email} to {user['email']} for user {user_url}")
     hub_client.session.put(user_url, json=user)