Refactored the project layout, following the Python apps standards, improved the setup.py content for proper build and future pypi release publication

Author: tdruez

.travis.yml

@@ -3,4 +3,4 @@ python:
   - "2.6"
   - "2.7"
 install: "pip install -r requirements.txt --use-mirrors"
-script: python tests.py
+script: python setup.py test

about.ABOUT

@@ -1,4 +1,4 @@
-about_resource: .
+about_resource: about-code-tool/about.py
 
 name: ABOUT tool
 version: 0.8.1
@@ -14,9 +14,9 @@ changelog_file: CHANGELOG.txt
 vcs_tool: git
 vcs_repository: https://github.com/dejacode/about-code-tool.git
 
-description: This is a tool to process ABOUT files. An ABOUT file provides a 
- simple way to document the provenance (origin and license) 'about' a software 
- component. An ABOUT file is a small text file stored in the codebase 
+description: This is a tool to process ABOUT files. An ABOUT file provides a
+ simple way to document the provenance (origin and license) 'about' a software
+ component. An ABOUT file is a small text file stored in the codebase
  side-by-side with the software component that it documents.
 
 
@@ -35,4 +35,3 @@ notice:
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-

MAPPING.CONFIG about_code_tool/MAPPING.CONFIGMAPPING.CONFIG renamed to about_code_tool/MAPPING.CONFIG

@@ -0,0 +1,12 @@
+# =============================================================================
+#  Copyright (c) 2013 by nexB, Inc. http://www.nexb.com/ - All rights reserved.
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#      http://www.apache.org/licenses/LICENSE-2.0
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+# =============================================================================

about_code_tool/__init__.py

@@ -42,8 +42,10 @@
 Warn = namedtuple('Warn', 'field_name field_value message',)
 Error = namedtuple('Error', 'field_name field_value message',)
 
+self_path = abspath(dirname(__file__))
+
+
 class GenAbout(object):
-    
     def __init__(self):
         self.warnings = []
         self.errors = []
@@ -93,7 +95,6 @@ def read_input(self, input_file, mapping):
             components_list.append(file_list)
         return components_list
 
-
     @staticmethod
     def config_mapping(mapping):
         about_resource = 'about_resource'
@@ -102,7 +103,7 @@ def config_mapping(mapping):
         version = 'version'
         if mapping:
             try:
-                with open('MAPPING.CONFIG', "rU") as file_in:
+                with open(join(self_path, 'MAPPING.CONFIG'), "rU") as file_in:
                     for line in file_in.readlines():
                         if not line.startswith('#'):
                             if line.partition(':')[0] == 'about_resource':
@@ -129,7 +130,6 @@ def config_mapping(mapping):
         else:
             return about_resource, about_file, name, version
 
-
     def verify_license_files(self, input_list, project_path):
         """
         Verify the existence of the 'license text file'
@@ -162,7 +162,6 @@ def verify_license_files(self, input_list, project_path):
                     sys.exit(errno.EINVAL)
         return output_list
 
-
     def copy_license_files(self, gen_location, license_list):
         """
         copy the 'license_text_file' into the gen_location
@@ -177,15 +176,14 @@ def copy_license_files(self, gen_location, license_list):
                 makedirs(license_parent_dir)
             shutil.copy2(license_path, output_license_path)
 
-    """ 
+    """
     def extract_licesen_from_url(self):
         # This function needs discussion
         test = urllib2.urlopen("https://enterprise.dejacode.com/license_library/Demo/gpl-1.0/#license-text")
         with open('testdata/test_file.txt', 'wb') as output_file:
             output_file.write(test.read())
     """
 
-
     def pre_generation(self, gen_location, input_list, action_num, all_in_one):
         """
         check the existence of the output location and handle differently
@@ -234,7 +232,6 @@ def pre_generation(self, gen_location, input_list, action_num, all_in_one):
                 output_list.append(component_list)
         return output_list
 
-
     def format_output(self, input_list):
         """
         process the input and covert to the specific strings format
@@ -270,7 +267,6 @@ def format_output(self, input_list):
             components_list.append(component)
         return components_list
 
-
     def write_output(self, output):
         for line in output:
             about_file_location = line[0]
@@ -280,7 +276,6 @@ def write_output(self, output):
             with open(about_file_location, 'wb') as output_file:
                 output_file.write(context)
 
-
     def warnings_errors_summary(self, gen_location, show_error_num):
         display_error = False
         display_warning = False

about.py about_code_tool/about.pyabout.py renamed to about_code_tool/about.py

@@ -0,0 +1,12 @@
+# =============================================================================
+#  Copyright (c) 2013 by nexB, Inc. http://www.nexb.com/ - All rights reserved.
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#      http://www.apache.org/licenses/LICENSE-2.0
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+# =============================================================================

genabout.py about_code_tool/genabout.pygenabout.py renamed to about_code_tool/genabout.py

@@ -23,7 +23,7 @@
 import tempfile
 import unittest
 
-import about
+from about_code_tool import about
 
 
 class BasicTest(unittest.TestCase):