Code enhancement and provide template of license reference

chinyeungli · chinyeungli · commit 9b40ac451376 · 2021-11-02T15:15:51.000+08:00
Signed-off-by: Chin Yeung Li &lt;tli@nexb.com&gt;
diff --git a/src/attributecode/attrib.py b/src/attributecode/attrib.py
@@ -114,6 +114,9 @@ def generate(abouts, is_about_input, license_dict, min_license_score, template=N
             # Add the license name expression string into the about object as a list
             about.license_name_expression = lic_name_expression
 
+    # Sort the license object by key
+    licenses_list = sorted(licenses_list, key=lambda x: x.key)
+
     rendered = template.render(
         abouts=abouts, 
         common_licenses=COMMON_LICENSES,
diff --git a/src/attributecode/cmd.py b/src/attributecode/cmd.py
@@ -370,10 +370,6 @@ def attrib(input, output, api_url, api_key, scancode, min_license_score, referen
     license_dict = {}
     errors = []
 
-    if not quiet:
-        print_version()
-        click.echo('Generating attribution...')
-
     # accept zipped ABOUT files as input
     if input.lower().endswith('.zip'):
         input = extract_zip(input)
@@ -413,6 +409,8 @@ def attrib(input, output, api_url, api_key, scancode, min_license_score, referen
         if errors:
             errors = unique(errors)
             errors_count = report_errors(errors, quiet, verbose, log_file_loc=output + '-error.log')
+            msg = 'Attribution generation halted.'
+            click.echo(msg)
         else:
             msg = 'No ABOUT file or reference is found from the input. Attribution generation halted.'
             click.echo(msg)
@@ -447,6 +445,9 @@ def attrib(input, output, api_url, api_key, scancode, min_license_score, referen
                     #sys.exit(1)
 
     if abouts:
+        if not quiet:
+            print_version()
+            click.echo('Generating attribution...')
         attrib_errors, rendered = generate_attribution_doc(
             abouts=abouts,
             is_about_input=is_about_input,
diff --git a/templates/template_license_ref_by_license.html b/templates/template_license_ref_by_license.html
@@ -0,0 +1,67 @@
+<!doctype html>
+<html>
+<head>
+	<style type="text/css">
+		div.additional-license-text-list {display:block}
+		body {font-family: Helvetica, Arial, sans-serif;}
+		pre {white-space: pre-wrap;}
+		li {font-weight: bold;}
+		#header {font-family: Helvetica; font-style:italic}
+	</style>
+	<title>{{ variables['title'] }}</title>
+</head>
+<body>
+	<h1>{{ variables['title'] }}</h1>
+	<pre id="header">
+
+This document lists the open source and third-party components of a [COMPANY NAME] product with additional information regarding licenses, acknowledgments and required copyright notices for these components.  This document is for internal [COMPANY NAME] use only.
+
+	</pre>
+
+	<hr>
+	<div class="oss-table-of-contents">
+		{% for license in licenses_list %}
+		<p>
+			<a href="#group_{{ loop.index0 }}">{{ license.name }}
+			</a>
+		</p>
+		{% endfor %}
+		
+	</div>
+	<hr>
+
+	{% for license in licenses_list %}
+		<div id="group_{{ loop.index0 }}">
+			<h3>{{ license.name }}</h3>
+			<p>This product contains the following open source software packages licensed under the terms of the license: {{license.name}}</p>
+			
+			<div class="oss-component" id="component_{{ loop.index0 }}">
+			{%for about_object in abouts %} 
+				{% if loop.first %}
+					{% if license.url %}
+						<p>License Gallery URL: <a href="{{ license.url }}">{{license.url}}</a> </p>
+					{% endif %}
+				{% endif %}
+				{% if license.key in about_object.license_key.value %}        
+					<li>{{ about_object.name.value }}{% if about_object.version.value %}  - Version  {{ about_object.version.value }}{% endif %}</li>		
+					{% if about_object.copyright.value %}
+						<pre>{{about_object.copyright.value}}</pre>
+					{% endif %}
+					{% if about_object.notice_file.value %}
+						<pre>{{ about_object.notice_file.value }}</pre>
+					{% elif about_object.notice_file.value %}
+						<pre class="component-notice">{{ about_object.notice_text.value }}</pre>
+					{% endif %}
+				{% endif %}
+				{% if loop.last %}
+					<pre>{{license.text}}</pre>
+				{% endif %}
+			{% endfor %}
+			</div>
+		</div>
+	{% endfor %}
+	<hr>
+<hr> 
+<h3><a id="End">End</a></h3>
+</body>
+</html>
