#481 - Add Excel support as input for gen

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

Author: chinyeungli

CHANGELOG.rst

@@ -14,6 +14,7 @@
     * Add new option to choose extract license from ScanCode LicenseDB or DJC License Library
     * Add ability to transform Excel formatted file 
     * Generate attribution directly from CSV/JSON/Excel file
+    * Generate ABOUT files with excel as an input
 
 2021-04-02
     Release 6.0.0

src/attributecode/cmd.py

@@ -199,7 +199,7 @@ def inventory(location, output, format, quiet, verbose):  # NOQA
 
 
 @about.command(cls=AboutCommand,
-    short_help='Generate .ABOUT files from an inventory as CSV or JSON.')
+    short_help='Generate .ABOUT files from an inventory as CSV/JSON/Excel.')
 
 @click.argument('location',
     required=True,
@@ -245,9 +245,9 @@ def inventory(location, output, format, quiet, verbose):  # NOQA
 @click.help_option('-h', '--help')
 def gen(location, output, android, fetch_license, fetch_license_djc, reference, quiet, verbose):
     """
-Given a CSV/JSON inventory, generate ABOUT files in the output location.
+Given a CSV/JSON/Excel inventory, generate ABOUT files in the output location.
 
-LOCATION: Path to a JSON or CSV inventory file.
+LOCATION: Path to a JSON/CSV/Excel inventory file.
 
 OUTPUT: Path to a directory where ABOUT files are generated.
     """
@@ -256,8 +256,8 @@ def gen(location, output, android, fetch_license, fetch_license_djc, reference,
         click.echo('Generating .ABOUT files...')
 
     # FIXME: This should be checked in the `click`
-    if not location.endswith(('.csv', '.json',)):
-        raise click.UsageError('ERROR: Invalid input file extension: must be one .csv or .json.')
+    if not location.endswith(('.csv', '.json', '.xlsx')):
+        raise click.UsageError('ERROR: Invalid input file extension: must be one .csv or .json or .xlsx.')
 
     errors, abouts = generate_about_files(
         location=location,
@@ -297,7 +297,7 @@ def validate_template(ctx, param, value):
 
 
 @about.command(cls=AboutCommand,
-    short_help='Generate an attribution document from .ABOUT files.')
+    short_help='Generate an attribution document from JSON/CSV/Excel/.ABOUT files.')
 
 @click.argument('input',
     required=True,

tests/testdata/test_cmd/help/about_gen_help.txt

@@ -1,8 +1,8 @@
 Usage: about gen [OPTIONS] LOCATION OUTPUT
 
-  Given a CSV/JSON inventory, generate ABOUT files in the output location.
+  Given a CSV/JSON/Excel inventory, generate ABOUT files in the output location.
 
-  LOCATION: Path to a JSON or CSV inventory file.
+  LOCATION: Path to a JSON/CSV/Excel inventory file.
 
   OUTPUT: Path to a directory where ABOUT files are generated.
 

tests/testdata/test_cmd/help/about_help.txt

@@ -13,11 +13,12 @@ Options:
   -h, --help  Show this message and exit.
 
 Commands:
-  attrib              Generate an attribution document from .ABOUT files.
+  attrib              Generate an attribution document from
+                      JSON/CSV/Excel/.ABOUT files.
   check               Validate that the format of .ABOUT files is correct and
                       report errors and warnings.
   collect-redist-src  Collect redistributable sources.
-  gen                 Generate .ABOUT files from an inventory as CSV or JSON.
+  gen                 Generate .ABOUT files from an inventory as CSV/JSON/Excel.
   inventory           Collect the inventory of .ABOUT files to a CSV or JSON
                       file.
   transform           Transform a CSV/JSON/Excel by applying renamings, filters