Update "Excel" reference to "XLSX" reference

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

Author: chinyeungli

CHANGELOG.rst

@@ -13,7 +13,7 @@
     * Add Dockerfile to run aboutcode with docker
     * Add new option to choose extract license from ScanCode LicenseDB or DJC License Library
     * Add ability to transform Excel formatted file 
-    * Support Excel file format for `inventory`, `gen` and `attrib`
+    * Support XLSX file format for `inventory`, `gen` and `attrib`
     * Add 'spdx_license_key' support
     * Add option to save error log in `check` command
     * New `gen_license` option

docs/source/general.rst

@@ -9,7 +9,7 @@ AboutCode Toolkit Defined
 
 AboutCode Toolkit is a tool for your software development team to document your code inside your codebase, typically in preparation for a product release, side-by-side with the actual code. ABOUT file(s) have a simple, standard format that identifies components and their associated licenses. The current AboutCode Toolkit subcommands are:
 
--   **attrib**: Generate a Product Attribution notice document from your ABOUT file(s), JSON, CSV or Excel. You can also generate documents for other purposes (such as a License Reference) by varying your input control file and your template.
+-   **attrib**: Generate a Product Attribution notice document from your ABOUT file(s), JSON, CSV or XLSX. You can also generate documents for other purposes (such as a License Reference) by varying your input control file and your template.
 
 -   **check**: A simple command to validate the ABOUT file(s) and output errors/warnings if any on the terminal.
 
@@ -21,7 +21,7 @@ AboutCode Toolkit is a tool for your software development team to document your
 
 -   **inventory**: Generate a Software Inventory list (.csv, .json or .xlsx format) from your codebase based on ABOUT file(s). Note that this Software Inventory will only include components that have AboutCode Toolkit data. In another word, if you do not create AboutCode Toolkit files for your own original software components, these components will not show up in the generated inventory.
 
--   **transform**: A command to transform an input CSV/JSON/Excel by applying renaming and/or filtering and then output to a new CSV/JSON/Excel file.
+-   **transform**: A command to transform an input CSV/JSON/XLSX by applying renaming and/or filtering and then output to a new CSV/JSON/Excel file.
 
 Additional AboutCode Toolkit information is available at:
 
@@ -173,11 +173,11 @@ Fields Renaming and Optional Custom Fields
 
 Since your input's field name may not match with the AboutCode Toolkit standard field name, you can use the transform subcommand to do the transformation.
 
-A transform configuration file is used to describe which transformations and validations to apply to a source CSV/JSON/Excel file. This is a simple text file using YAML format, using the same format as an .ABOUT file.
+A transform configuration file is used to describe which transformations and validations to apply to a source CSV/JSON/XLSX file. This is a simple text file using YAML format, using the same format as an .ABOUT file.
 
 The attributes that can be set in a configuration file are:
 
--   field_renamings: An optional map of source field name to target new field name that is used to rename CSV/JSON/Excel fields.
+-   field_renamings: An optional map of source field name to target new field name that is used to rename CSV/JSON/XLSX fields.
 
         ..  code-block:: none
 
@@ -189,7 +189,7 @@ The attributes that can be set in a configuration file are:
 The renaming is always applied first before other transforms and checks. All other field names referenced below are AFTER the renaming have been applied.
 For instance with this configuration, the field "Directory/Location" will be renamed to "about_resource" and "foo" to "bar":
 
--   required_fields: An optional list of required field names that must have a value, beyond the standard field names. If a source CSV/JSON/Excel does not have such a field or an entry is missing a value for a required field, an error is reported.
+-   required_fields: An optional list of required field names that must have a value, beyond the standard field names. If a source CSV/JSON/XLSX does not have such a field or an entry is missing a value for a required field, an error is reported.
 
 For instance with this configuration, an error will be reported if the fields "name" and "version" are missing, or if any entry does not have a value set for these fields:
 

docs/source/reference.rst

@@ -27,13 +27,13 @@ Commands
 
         ..  code-block:: none
 
-                attrib              Generate an attribution document from JSON/CSV/Excel/.ABOUT files.
+                attrib              Generate an attribution document from JSON/CSV/XLSX/.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/JSON/Excel.
-                inventory           Collect the inventory of .ABOUT files to a CSV/JSON/Excel file.
-                transform           Transform a CSV/JSON/Excel by applying renamings, filters and checks.
+                gen                 Generate .ABOUT files from an inventory as CSV/JSON/XLSX.
+                inventory           Collect the inventory of .ABOUT files to a CSV/JSON/XLSX file.
+                transform           Transform a CSV/JSON/XLSX by applying renamings, filters and checks.
 
 attrib
 ======
@@ -300,7 +300,7 @@ Syntax
 
                 about gen [OPTIONS] LOCATION OUTPUT
                 
-                LOCATION: Path to a JSON/CSV/Excel inventory file.
+                LOCATION: Path to a JSON/CSV/XLSX inventory file.
                 OUTPUT: Path to a directory where ABOUT files are generated.
 
 Options
@@ -334,7 +334,7 @@ Options
 Purpose
 -------
 
-Given a CSV/JSON/Excel inventory, generate ABOUT files in the output location.
+Given a CSV/JSON/XLSX inventory, generate ABOUT files in the output location.
 
 Details
 ^^^^^^^
@@ -402,7 +402,7 @@ Syntax
 
                 about gen_license [OPTIONS] LOCATION OUTPUT
 
-                LOCATION: Path to a JSON/CSV/Excel/.ABOUT file(s)
+                LOCATION: Path to a JSON/CSV/XLSX/.ABOUT file(s)
                 OUTPUT: Path to a directory where license files are saved.
 
 Options
@@ -468,7 +468,7 @@ Syntax
                 about inventory [OPTIONS] LOCATION OUTPUT
                 
                 LOCATION: Path to an ABOUT file or a directory with ABOUT files.
-                OUTPUT: Path to the CSV/JSON/Excel inventory file to create.
+                OUTPUT: Path to the CSV/JSON/XLSX inventory file to create.
 
 Options
 -------
@@ -483,7 +483,7 @@ Options
 Purpose
 -------
 
-Create a JSON/CSV/Excel inventory of components from ABOUT files.
+Create a JSON/CSV/XLSX inventory of components from ABOUT files.
 
 Details
 ^^^^^^^
@@ -566,8 +566,8 @@ Syntax
 
                 about transform [OPTIONS] LOCATION OUTPUT
                 
-                LOCATION: Path to a CSV/JSON/Excel file.
-                OUTPUT: Path to CSV/JSON/Excel inventory file to create.
+                LOCATION: Path to a CSV/JSON/XLSX file.
+                OUTPUT: Path to CSV/JSON/XLSX inventory file to create.
 
 Options
 -------
@@ -584,7 +584,7 @@ Options
 Purpose
 -------
 
-Transform the CSV/JSON/Excel file at LOCATION by applying renamings, filters and checks and then write a new CSV/JSON/Excel to OUTPUT (Format for input and output need to be the same).
+Transform the CSV/JSON/XLSX file at LOCATION by applying renamings, filters and checks and then write a new CSV/JSON/Excel to OUTPUT (Format for input and output need to be the same).
 
 Details
 ^^^^^^^

docs/source/specification.rst

@@ -119,7 +119,7 @@ Fields order and multiple occurrences
 
 The field order does not matter. Multiple occurrences of a field name is not supported.
 
-The tool processing an ABOUT file or CSV/JSON/Excel input will issue an error when a field name occurs more than once in the input file.
+The tool processing an ABOUT file or CSV/JSON/XLSX input will issue an error when a field name occurs more than once in the input file.
 
 Field referencing a file
 ------------------------

src/attributecode/cmd.py

@@ -141,7 +141,7 @@ def validate_extensions(ctx, param, value, extensions=tuple(('.csv', '.json',)))
 
 
 @about.command(cls=AboutCommand,
-    short_help='Collect the inventory of .ABOUT files to a CSV/JSON/Excel file.')
+    short_help='Collect the inventory of .ABOUT files to a CSV/JSON/XLSX file.')
 
 @click.argument('location',
     required=True,
@@ -172,11 +172,11 @@ def validate_extensions(ctx, param, value, extensions=tuple(('.csv', '.json',)))
 @click.help_option('-h', '--help')
 def inventory(location, output, format, quiet, verbose):  # NOQA
     """
-Collect the inventory of .ABOUT files to a CSV/JSON/Excel file.
+Collect the inventory of .ABOUT files to a CSV/JSON/XLSX file.
 
 LOCATION: Path to an ABOUT file or a directory with ABOUT files.
 
-OUTPUT: Path to the CSV/JSON/Excel inventory file to create.
+OUTPUT: Path to the CSV/JSON/XLSX inventory file to create.
     """
     if not quiet:
         print_version()
@@ -200,7 +200,7 @@ def inventory(location, output, format, quiet, verbose):  # NOQA
 
 
 @about.command(cls=AboutCommand,
-    short_help='Generate .ABOUT files from an inventory as CSV/JSON/Excel.')
+    short_help='Generate .ABOUT files from an inventory as CSV/JSON/XLSX.')
 
 @click.argument('location',
     required=True,
@@ -246,9 +246,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/Excel inventory, generate ABOUT files in the output location.
+Given a CSV/JSON/XLSX inventory, generate ABOUT files in the output location.
 
-LOCATION: Path to a JSON/CSV/Excel inventory file.
+LOCATION: Path to a JSON/CSV/XLSX inventory file.
 
 OUTPUT: Path to a directory where ABOUT files are generated.
     """
@@ -314,7 +314,7 @@ def gen_license(location, output, djc, scancode, verbose):
     """
 Fetch licenses (Default: ScanCode LicenseDB) in the license_expression field and save to the output location.
 
-LOCATION: Path to a JSON/CSV/Excel/.ABOUT file(s)
+LOCATION: Path to a JSON/CSV/XLSX/.ABOUT file(s)
 
 OUTPUT: Path to a directory where license files are saved.
     """
@@ -378,7 +378,7 @@ def validate_template(ctx, param, value):
 
 
 @about.command(cls=AboutCommand,
-    short_help='Generate an attribution document from JSON/CSV/Excel/.ABOUT files.')
+    short_help='Generate an attribution document from JSON/CSV/XLSX/.ABOUT files.')
 
 @click.argument('input',
     required=True,
@@ -442,7 +442,7 @@ def validate_template(ctx, param, value):
 @click.help_option('-h', '--help')
 def attrib(input, output, api_url, api_key, scancode, min_license_score, reference, template, vartext, quiet, verbose):
     """
-Generate an attribution document at OUTPUT using JSON, CSV or Excel or .ABOUT files at INPUT.
+Generate an attribution document at OUTPUT using JSON, CSV or XLSX or .ABOUT files at INPUT.
 
 INPUT: Path to a file (.ABOUT/.csv/.json/.xlsx), directory or .zip archive containing .ABOUT files.
 
@@ -726,7 +726,7 @@ def print_config_help(ctx, param, value):
 
 
 @about.command(cls=AboutCommand,
-    short_help='Transform a CSV/JSON/Excel by applying renamings, filters and checks.')
+    short_help='Transform a CSV/JSON/XLSX by applying renamings, filters and checks.')
 
 @click.argument('location',
     required=True,
@@ -762,13 +762,13 @@ def print_config_help(ctx, param, value):
 @click.help_option('-h', '--help')
 def transform(location, output, configuration, quiet, verbose):  # NOQA
     """
-Transform the CSV/JSON/Excel file at LOCATION by applying renamings, filters and checks
-and then write a new CSV/JSON/Excel to OUTPUT (Format for input and output need to be
+Transform the CSV/JSON/XLSX file at LOCATION by applying renamings, filters and checks
+and then write a new CSV/JSON/XLSX to OUTPUT (Format for input and output need to be
 the same).
 
-LOCATION: Path to a CSV/JSON/Excel file.
+LOCATION: Path to a CSV/JSON/XLSX file.
 
-OUTPUT: Path to CSV/JSON/Excel inventory file to create.
+OUTPUT: Path to CSV/JSON/XLSX inventory file to create.
     """
     if not configuration:
         transformer = Transformer.default()

src/attributecode/transform.py

@@ -88,7 +88,7 @@ def transform_json_to_json(location, output, transformer):
 
 def transform_excel_to_excel(location, output, transformer):
     """
-    Read a Excel file at `location` and write a new Excel file at `output`. Apply
+    Read a XLSX file at `location` and write a new Excel file at `output`. Apply
     transformations using the `transformer` Transformer.
     Return a list of Error objects.
     """
@@ -415,7 +415,7 @@ def write_json(location, data):
 
 def read_excel(location):
     """
-    Read Excel at `location`, return a list of ordered dictionaries, one
+    Read XLSX at `location`, return a list of ordered dictionaries, one
     for each row.
     """
     results = []

src/attributecode/util.py

@@ -670,7 +670,7 @@ def load_scancode_json(location):
 
 def load_excel(location):
     """
-    Read Excel at `location`, return a list of ordered dictionaries, one
+    Read XLSX at `location`, return a list of ordered dictionaries, one
     for each row.
     """
     results = []

tests/test_cmd.py

@@ -334,6 +334,10 @@ def check_about_stdout(options, expected_loc, regen=False):
     with open(expected_file, 'r') as ef:
         expected = ef.read()
 
+    print("!!!!!!!!!!!!!!!!!!!!")
+    print(expected.splitlines(False))
+    print("#####################")
+    print(result.output.splitlines(False))
     assert expected.splitlines(False) == result.output.splitlines(False)
 
 

tests/testdata/test_cmd/help/about_attrib_help.txt

@@ -1,6 +1,6 @@
 Usage: about attrib [OPTIONS] INPUT OUTPUT
 
-  Generate an attribution document at OUTPUT using JSON, CSV or Excel or .ABOUT
+  Generate an attribution document at OUTPUT using JSON, CSV or XLSX or .ABOUT
   files at INPUT.
 
   INPUT: Path to a file (.ABOUT/.csv/.json/.xlsx), directory or .zip archive

tests/testdata/test_cmd/help/about_gen_help.txt

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