#332

Implemented the `--title` option. However, we, probably, want a more
generic way to pass variables.

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

Author: chinyeungli

src/attributecode/__init__.py

@@ -27,7 +27,7 @@
     basestring = str  # Python 3
 
 
-__version__ = '3.1.1'
+__version__ = '3.1.2'
 
 
 __about_spec_version__ = '3.0.0'

src/attributecode/attrib.py

@@ -37,7 +37,7 @@
 from attributecode.util import add_unc
 
 
-def generate(abouts, template_string=None):
+def generate(abouts, template_string=None, title=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):
                                    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)
+                                   utcnow=utcnow, title=title)
     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):
+def generate_from_file(abouts, template_loc=None, title=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):
     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)
+    return generate(abouts, template_string=tpls, title=title)
 
 
 def generate_and_save(abouts, output_location, use_mapping=False, mapping_file=None,
-                      template_loc=None, inventory_location=None):
+                      template_loc=None, inventory_location=None, title=None):
     """
     Generate attribution file using the `abouts` list of About object
     at `output_location`.
@@ -239,7 +239,7 @@ 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)
+    rendered = generate_from_file(updated_abouts, template_loc=template_loc, title=title)
 
     if rendered:
         output_location = add_unc(output_location)

src/attributecode/cmd.py

@@ -290,6 +290,11 @@ def gen(location, output, mapping, mapping_file, license_notice_text_location, f
     type=click.Path(exists=True, dir_okay=True, readable=True, resolve_path=True),
     help='Use a custom mapping file with mapping between input keys and ABOUT field names.')
 
+@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('--verbose', is_flag=True, default=False,
     help='Show all errors and warnings. '
         'By default, the tool only prints these '
@@ -298,15 +303,12 @@ def gen(location, output, mapping, mapping_file, license_notice_text_location, f
         'for any level.'
 )
 
-@click.option('--template', type=click.Path(exists=True), nargs=1,
-    help='Path to an optional custom attribution template used for generation.')
-
 @click.option('-q', '--quiet', is_flag=True,
     help='Do not print error or warning messages.')
 
 @click.help_option('-h', '--help')
 
-def attrib(location, output, template, mapping, mapping_file, inventory, quiet, verbose):
+def attrib(location, output, template, mapping, mapping_file, inventory, title, quiet, verbose):
     """
 Generate an attribution document at OUTPUT using .ABOUT files at LOCATION.
 
@@ -325,7 +327,7 @@ def attrib(location, output, template, mapping, mapping_file, inventory, quiet,
     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)
+        inventory_location=inventory, title=title)
 
     if not no_match_errors:
         # Check for template error