Use CSV on Python3 and improve CLI help #280

 * Use cvs and not backports.csv on Pyhton 3
 * Reference .ABOUT files consistently
 * Enable using -h as a help option shortcut
 * Improve the help for the main entry point and each
   command
 * cleanup the setup.py

Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

about.ABOUT

@@ -1,12 +1,12 @@
 about_resource: .
 
-name: AboutCode
-version: 3.0.0.dev4
+name: AboutCode-toolkit
+version: 3.0.0.dev6
 
 owner: nexB Inc.
 author: Jillian Daguil, Chin Yeung Li, Philippe Ombredanne, Thomas Druez
 
-home_url: http://dejacode.org
+home_url: https://aboutcode.org
 
 vcs_tool: git
 vcs_repository: https://github.com/dejacode/about-code-tool.git

setup.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
+# -*- encoding: utf-8 -*-
 
 from __future__ import absolute_import
 from __future__ import print_function
@@ -10,6 +10,9 @@
 from os.path import dirname
 from os.path import join
 from os.path import splitext
+import re
+import sys
+
 from setuptools import find_packages
 from setuptools import setup
 
@@ -22,10 +25,10 @@ def read(*names, **kwargs):
 
 
 setup(
-    name='attributecode',
-    version='3.0.0.dev4',
+    name='aboutcode-toolkit',
+    version='3.0.0.dev6',
     license='Apache-2.0',
-    description=('Document the provenance (origin and license) of '
+    description=('AboutCode-toolkit is a tool to d_ocument the provenance (origin and license) of '
                  'third-party software using small text files. '
                  'Collect inventories, generate attribution documentation.'),
     long_description=('AttributeCode provides a simple way to document the'
@@ -46,19 +49,23 @@ def read(*names, **kwargs):
         'Programming Language :: Python',
         'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.6',
+        'Intended Audience :: Developers',
         'License :: OSI Approved :: Apache Software License',
         'Operating System :: OS Independent',
-        'Intended Audience :: Developers',
         'Topic :: Software Development',
         'Topic :: Software Development :: Documentation',
         'Topic :: Software Development :: Quality Assurance',
         'Topic :: System :: Software Distribution',
         'Topic :: Utilities',
     ],
     keywords=[
-        'license', 'about', 'metadata', 'package', 'copyright', 
+        'license', 'about', 'metadata', 'package', 'copyright',
         'attribution', 'software', 'inventory',
     ],
+    # FIXME: we SHOULD NOT use datafiles!!!! whcih is a mine field but
+    # only package data or use a MANIFEST.in instead for a sdist
     data_files=[('about',
         [
             'about.ABOUT',
@@ -74,31 +81,17 @@ def read(*names, **kwargs):
             'USAGE.rst',
         ]),
     ],
-
-    entry_points='''
-        [console_scripts]
-        about-code=attributecode.cmd:cli
-    ''',
     install_requires=[
         'jinja2 >= 2.9, < 3.0',
         'click >= 6.7, < 7.0',
-        'backports.csv >= 1.0.5,  < 2.0.0',
+        'backports.csv;python_version<"3.6"',
         'pyyaml >= 3.11, < 3.13',
         'boolean.py >= 3.5, < 4.0',
         'license_expression >= 0.94, < 1.0',
-     ],
-
-    extras_require={
-        'base': [
-            'certifi',
-            'setuptools',
-            'wheel',
-            'pip',
-            'wincertstore',
-        ],
-        'dev': [
-            'pytest',
-            'py',
-        ],
-    }
+    ],
+    entry_points={
+        'console_scripts': [
+            'about-code=attributecode.cmd:cli',
+        ]
+    },
 )

src/attributecode/__init__.py

@@ -27,7 +27,8 @@
     basestring = str  # Python 3
 
 
-__version__ = '3.0.0.dev5'
+__version__ = '3.0.0.dev6'
+
 
 __about_spec_version__ = '2.0.0.dev2'
 
@@ -44,6 +45,7 @@
 limitations under the License.
 """
 
+
 class Error(namedtuple('Error', ['severity', 'message'])):
     """
     An Error data with a severity and message.

src/attributecode/attrib.py

@@ -38,7 +38,7 @@
 
 def generate(abouts, template_string=None):
     """
-    Generate and return attribution text from a list of ABOUT objects and a
+    Generate and return attribution text from a list of About objects and a
     template string.
     The returned rendered text may contain template processing error messages.
     """
@@ -127,7 +127,7 @@ def check_template(template_string):
 
 def generate_from_file(abouts, template_loc=None):
     """
-    Generate and return attribution string from a list of ABOUT objects and a
+    Generate and return attribution string from a list of About objects and a
     template location.
     """
     if not template_loc:
@@ -138,12 +138,18 @@ def generate_from_file(abouts, template_loc=None):
     return generate(abouts, template_string=tpls)
 
 
-def generate_and_save(abouts, output_location, use_mapping=False, 
+def generate_and_save(abouts, output_location, use_mapping=False,
                       template_loc=None, inventory_location=None):
     """
-    Generate attribution using template and save at output_location.
-    Filter the list of about object based on the inventory CSV at
-    inventory_location.
+    Generate attribution file using the `abouts` list of About object
+    at `output_location`.
+
+    Use the optional `template_loc` custom temaplte or a default template.
+
+    Optionally filter `abouts` object based on the inventory JSON or
+    CSV at `inventory_location`.
+
+    Optionally use the mapping.config file is `use_mapping` is True
     """
     updated_abouts = []
     lstrip_afp = []
@@ -156,22 +162,28 @@ def generate_and_save(abouts, output_location, use_mapping=False,
     # Do the following if an filter list (inventory_location) is provided
     else:
         if not exists(inventory_location):
-            msg = (u'"INVENTORY_LOCATOIN" does not exist. Generation halted.')
+            # FIXME: this message does not make sense
+            msg = (u'"INVENTORY_LOCATION" does not exist. Generation halted.')
             errors.append(Error(ERROR, msg))
             return errors
 
         if inventory_location.endswith('.csv') or inventory_location.endswith('.json'):
+            # FIXME: we should use the same inventory lodaing that we use everywhere!!!!
+
             try:
                 # Return a list which contains only the about file path
                 about_list = attributecode.util.get_about_file_path(
                     inventory_location, use_mapping=use_mapping)
+            # FIXME: why catching all exceptions?
             except Exception:
                 # 'about_file_path' key/column doesn't exist
+
                 msg = u"The required key: 'about_file_path' does not exist. Generation halted."
                 errors.append(Error(ERROR, msg))
                 return errors
         else:
-            msg = u'Only .csv and .json are supported for the "INVENTORY_LOCATOIN". Generation halted.'
+            # FIXME: this message does not make sense
+            msg = u'Only .csv and .json are supported for the "INVENTORY_LOCATION". Generation halted.'
             errors.append(Error(ERROR, msg))
             return errors
 
@@ -225,16 +237,19 @@ def generate_and_save(abouts, output_location, use_mapping=False,
 
     return errors
 
+
 def as_about_paths(paths):
     """
-    Given a list of paths, return a list of paths that point all to .ABOUT files.
+    Return a list of paths to .ABOUT files from a list of `paths`
+    strings.
     """
-    normalized_paths = []
+    about_paths = []
     for path in paths:
         if path.endswith('.ABOUT'):
-            normalized_paths.append(path)
+            about_paths.append(path)
         else:
+            # FIXME: this is not the way to check that a path is a directory, too weak
             if path.endswith('/'):
                 path += basename(dirname(path))
-            normalized_paths.append(path + '.ABOUT')
-    return normalized_paths
+            about_paths.append(path + '.ABOUT')
+    return about_paths