#332

 * new `--vartext` option
 * updated changelog and usage

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

Author: chinyeungli

USAGE.rst

@@ -45,8 +45,9 @@ attrib
                                 names - mapping.config
     --mapping-file              Use a custom mapping file with mapping between input
                                 keys and ABOUT field names.
-    --verbose                   Show all the errors and warning.
     --template PATH             Path to a custom attribution template.
+    --vartext TEXT              Variable texts to the attribution template
+    --verbose                   Show all the errors and warning.
     -q, --quiet                 Do not print any error/warning.
     -h, --help                  Show this message and exit.
 
@@ -90,11 +91,6 @@ Options
 
     $ about attrib --mapping-file CUSTOM_MAPPING_FILE_PATH LOCATION OUTPUT
 
-    --verbose
-
-        This option tells the tool to show all errors found.
-        The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
-
     --template
 
         This option allows you to use your own template for attribution generation.
@@ -103,6 +99,21 @@ Options
 
     $ about attrib --template /home/custom_template/template.html LOCATION OUTPUT
 
+    --vartext
+
+        This option allow you to pass variable texts to the attribution template
+
+    $ about attrib --vartext "title=Attribution Notice" --vartext "header="Product 101" LOCATION OUTPUT
+
+        Users can use the following in the template to get the vartext:
+        {{ vartext_dict['title'] }}
+        {{ vartext_dict['header'] }} 
+
+    --verbose
+
+        This option tells the tool to show all errors found.
+        The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
+
 
 The following data are passed to jinja2 and, therefore, can be used for a custom template:
  * about object: the about objects
@@ -282,7 +293,7 @@ Options
 
         Same behavior as `--mapping` but with custom mapping file
 
-    $ about attrib --mapping-file CUSTOM_MAPPING_FILE_PATH LOCATION OUTPUT
+    $ about inventory --mapping-file CUSTOM_MAPPING_FILE_PATH LOCATION OUTPUT
 
     --verbose
 

docs/CHANGELOG.rst

@@ -1,3 +1,9 @@
+2018-x-x
+
+    Release 3.1.2
+
+    * New `--vartext` option
+
 2018-6-25
 
     Release 3.1.1

src/attributecode/attrib.py

@@ -37,7 +37,7 @@
 from attributecode.util import add_unc
 
 
-def generate(abouts, template_string=None, title=None):
+def generate(abouts, template_string=None, vartext_dict=None):
     """
     Generate and return attribution text from a list of About objects and a
     template string.
@@ -110,7 +110,7 @@ def generate(abouts, template_string=None, title=None):
                                    license_file_name_and_key=license_file_name_and_key,
                                    license_key_to_license_name=license_key_to_license_name,
                                    license_name_to_license_key=license_name_to_license_key,
-                                   utcnow=utcnow, title=title)
+                                   utcnow=utcnow, vartext_dict=vartext_dict)
     except Exception as e:
         line = getattr(e, 'lineno', None)
         ln_msg = ' at line: %r' % line if line else ''
@@ -134,7 +134,7 @@ def check_template(template_string):
 default_template = join(os.path.dirname(os.path.realpath(__file__)),
                                 'templates', 'default_html.template')
 
-def generate_from_file(abouts, template_loc=None, title=None):
+def generate_from_file(abouts, template_loc=None, vartext_dict=None):
     """
     Generate and return attribution string from a list of About objects and a
     template location.
@@ -144,11 +144,11 @@ def generate_from_file(abouts, template_loc=None, title=None):
     template_loc = add_unc(template_loc)
     with codecs.open(template_loc, 'rb', encoding='utf-8') as tplf:
         tpls = tplf.read()
-    return generate(abouts, template_string=tpls, title=title)
+    return generate(abouts, template_string=tpls, vartext_dict=vartext_dict)
 
 
 def generate_and_save(abouts, output_location, use_mapping=False, mapping_file=None,
-                      template_loc=None, inventory_location=None, title=None):
+                      template_loc=None, inventory_location=None, vartext=None):
     """
     Generate attribution file using the `abouts` list of About object
     at `output_location`.
@@ -167,6 +167,7 @@ def generate_and_save(abouts, output_location, use_mapping=False, mapping_file=N
     afp_list = []
     not_match_path = []
     errors = []
+    vartext_dict = {}
 
     if not inventory_location:
         updated_abouts = abouts
@@ -239,7 +240,14 @@ def generate_and_save(abouts, output_location, use_mapping=False, mapping_file=N
             else:
                 about.license.value = lic_list
 
-    rendered = generate_from_file(updated_abouts, template_loc=template_loc, title=title)
+    # Parse the vartext and save to the vartext dictionary
+    if vartext:
+        for var in vartext:
+            key = var.partition('=')[0]
+            value = var.partition('=')[2]
+            vartext_dict[key] = value
+
+    rendered = generate_from_file(updated_abouts, template_loc=template_loc, vartext_dict=vartext_dict)
 
     if rendered:
         output_location = add_unc(output_location)

src/attributecode/cmd.py

@@ -293,7 +293,8 @@ def gen(location, output, mapping, mapping_file, license_notice_text_location, f
 @click.option('--template', type=click.Path(exists=True), nargs=1,
     help='Path to an optional custom attribution template used for generation.')
 
-@click.option('--title', nargs=1, help='Title for the attribution output.')
+@click.option('--vartext', nargs=1, multiple=True, 
+    help='Variable texts to the attribution template.')
 
 @click.option('--verbose', is_flag=True, default=False,
     help='Show all errors and warnings. '
@@ -308,7 +309,7 @@ def gen(location, output, mapping, mapping_file, license_notice_text_location, f
 
 @click.help_option('-h', '--help')
 
-def attrib(location, output, template, mapping, mapping_file, inventory, title, quiet, verbose):
+def attrib(location, output, template, mapping, mapping_file, inventory, vartext, quiet, verbose):
     """
 Generate an attribution document at OUTPUT using .ABOUT files at LOCATION.
 
@@ -327,7 +328,7 @@ def attrib(location, output, template, mapping, mapping_file, inventory, title,
     no_match_errors = attrib_generate_and_save(
         abouts=abouts, output_location=output,
         use_mapping=mapping, mapping_file=mapping_file, template_loc=template,
-        inventory_location=inventory, title=title)
+        inventory_location=inventory, vartext=vartext)
 
     if not no_match_errors:
         # Check for template error