Adding Comments

Author: Suyog Potnis

examples/write_component_source_paths_to_custom_field.py

@@ -1,5 +1,17 @@
 #!/usr/bin/env python
 
+"""
+Date: 04/07/2020
+Requirements:
+1. Define a Custom Field at the BOM Component Level from the Black Duck UI under Custom Fields Management.
+2. The field type needs to be "Text Area"
+
+Script: Executing the script will write source paths of each component from a Project-Version to the defined Custom Field. 
+Executing the script again will simply overwrite the existing values with new ones. This is particularly useful if an end-user 
+is using REST APIs and would like to pull file paths.
+
+"""
+
 import argparse
 import logging
 
@@ -12,7 +24,8 @@
 
 args = parser.parse_args()
 
-custom_field_id = "4"
+# Set the Custom Field Id
+custom_field_id = ""
 
 
 custom_headers = {'Accept': 'application/vnd.blackducksoftware.bill-of-materials-6+json'}
@@ -23,6 +36,11 @@
 project = hub.get_project_by_name(args.project_name)
 version = hub.get_version_by_name(project, args.version)
 
+# Custom Field Id Check
+if custom_field_id == "":
+	print("Set the custom_field_id variable above with the correct Id and try executing the script again.")
+	exit()
+
 # Get all BOM Components
 bom_components = hub.get_version_components(version)