Update 'variables' in code and template to 'vartext'

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

docs/source/reference.rst

@@ -139,8 +139,8 @@ Details
                 $ about attrib --vartext "title=Attribution Notice" --vartext "header=Product 101" LOCATION OUTPUT
                 
                     Users can use the following in the template to get the vartext:
-                    {{ variables['title'] }}
-                    {{ variables['header'] }}
+                    {{ vartext['title'] }}
+                    {{ vartext['header'] }}
                 
                 --verbose
                 

src/attributecode/attrib.py

@@ -39,10 +39,10 @@
 
 DEFAULT_LICENSE_SCORE = 100
 
-def generate(abouts, is_about_input, license_dict, scancode, min_license_score, template=None, variables=None):
+def generate(abouts, is_about_input, license_dict, scancode, min_license_score, template=None, vartext=None):
     """
     Generate an attribution text from an `abouts` list of About objects, a
-    `template` template text and a `variables` optional dict of extra
+    `template` template text and a `vartext` optional dict of extra
     variables.
 
     Return a tuple of (error, attribution text) where error is an Error object
@@ -179,7 +179,7 @@ def generate(abouts, is_about_input, license_dict, scancode, min_license_score,
         licenses_list=licenses_list,
         utcnow=utcnow,
         tkversion=__version__,
-        variables=variables
+        vartext=vartext
     )
     return error, rendered
 
@@ -205,10 +205,10 @@ def check_template(template_string):
         return e.lineno, e.message
 
 
-def generate_from_file(abouts, is_about_input, license_dict, scancode, min_license_score, template_loc=None, variables=None):
+def generate_from_file(abouts, is_about_input, license_dict, scancode, min_license_score, template_loc=None, vartext=None):
     """
     Generate an attribution text from an `abouts` list of About objects, a
-    `template_loc` template file location and a `variables` optional
+    `template_loc` template file location and a `vartext` optional
     dict of extra variables.
 
     Return a tuple of (error, attribution text) where error is an Error object
@@ -223,13 +223,13 @@ def generate_from_file(abouts, is_about_input, license_dict, scancode, min_licen
         template_loc = add_unc(template_loc)
     with io.open(template_loc, encoding='utf-8', errors='replace') as tplf:
         tpls = tplf.read()
-    return generate(abouts, is_about_input, license_dict, scancode, min_license_score, template=tpls, variables=variables)
+    return generate(abouts, is_about_input, license_dict, scancode, min_license_score, template=tpls, vartext=vartext)
 
 
-def generate_and_save(abouts, is_about_input, license_dict, output_location, scancode=False, min_license_score=0, template_loc=None, variables=None):
+def generate_and_save(abouts, is_about_input, license_dict, output_location, scancode=False, min_license_score=0, template_loc=None, vartext=None):
     """
     Generate an attribution text from an `abouts` list of About objects, a
-    `template_loc` template file location and a `variables` optional
+    `template_loc` template file location and a `vartext` optional
     dict of extra variables. Save the generated attribution text in the
     `output_location` file.
     Return a list of Error objects if any.
@@ -251,7 +251,7 @@ def generate_and_save(abouts, is_about_input, license_dict, output_location, sca
         scancode=scancode,
         min_license_score=min_license_score,
         template_loc=template_loc,
-        variables=variables,
+        vartext=vartext,
     )
 
     if rendering_error:

src/attributecode/cmd.py

@@ -459,7 +459,7 @@ def attrib(input, output, api_url, api_key, scancode, min_license_score, referen
             scancode=scancode,
             min_license_score=min_license_score,
             template_loc=template,
-            variables=vartext,
+            vartext=vartext,
         )
         errors.extend(attrib_errors)
 

templates/default_html.template

@@ -11,7 +11,7 @@
 
   <body>
     <h1>OPEN SOURCE SOFTWARE INFORMATION</h1>
-    <h2> {{ variables['subtitle'] }} </h2>
+    <h2> {{ vartext['subtitle'] }} </h2>
     <div>
       <p>Licenses, acknowledgments and required copyright notices for 
       open source components:</p>

templates/license_ref.template

@@ -8,13 +8,13 @@
         li {font-weight: bold;}
         #header {font-family: Helvetica; font-style:italic}
     </style>
-    <title>{{ variables['title'] }}</title>
+    <title>{{ vartext['title'] }}</title>
 </head>
 <body>
-    <h1>{{ variables['title'] }}</h1>
+    <h1>{{ vartext['title'] }}</h1>
     <pre id="header">
 
-This document lists the open source and third-party components of a {{ variables['company'] }} product with additional information regarding licenses, acknowledgments and required copyright notices for these components.  This document is for internal {{ variables['company'] }} use only.
+This document lists the open source and third-party components of a {{ vartext['company'] }} product with additional information regarding licenses, acknowledgments and required copyright notices for these components.  This document is for internal {{ vartext['company'] }} use only.
 
     </pre>
 

templates/scancode_html.template

@@ -11,7 +11,7 @@
 
   <body>
     <h1>OPEN SOURCE SOFTWARE INFORMATION</h1>
-    <h2> {{ variables['subtitle'] }} </h2>
+    <h2> {{ vartext['subtitle'] }} </h2>
     <div>
       <p>Licenses, acknowledgments and required copyright notices for 
       open source components:</p>

tests/testdata/test_attrib/scancode_input/scancode.template

@@ -16,7 +16,7 @@ Read the JSON file to see what information can be extracted from the licenses.
 
   <body>
     <h1>OPEN SOURCE SOFTWARE INFORMATION</h1>
-	<h2>{{ variables['subtitle'] }}</h2>
+	<h2>{{ vartext['subtitle'] }}</h2>
     <div>
       <p>Licenses, acknowledgments and required copyright notices for 
       open source components:</p>