Merge branch 'release-v1.0.0'

Author: pombredanne

.gitignore

@@ -1,22 +1,14 @@
 *.py[cod]
 
-# C extensions
-*.so
-
-# Packages
-*.egg
-*.egg-info
-dist
-build
-eggs
-parts
-bin
-var
-sdist
-develop-eggs
-.installed.cfg
-lib
+/build
+/bin
+/var
+/lib
 lib64
+/Include
+/Lib
+/Scripts
+/include
 
 # Installer logs
 pip-log.txt
@@ -36,4 +28,5 @@ nosetests.xml
 /.settings
 
 # PyCharm project
-.idea/
+.idea/
+/about_code_tool.egg_info

.travis.yml

@@ -1,12 +1,13 @@
 language: python
+
 python:
   - "2.6"
   - "2.7"
 install:
-    - "pip install -r requirements.txt --use-mirrors"
-    - "pip install coverage"
-    - "pip install coveralls"
+    - source configure etc/conf
+    # extra reqs for testings on Travis
+    - pip install coverage coveralls
 script:
-    - "coverage run --source=about_code_tool setup.py test"
+    - coverage run --source=about_code_tool setup.py test
 after_success:
-    coveralls
+    - coveralls

NOTICE

@@ -0,0 +1,10 @@
+ Copyright (c) 2013-2014 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.

README.rst

@@ -43,30 +43,27 @@ version may be pre-installed, open a terminal and type::
     python2.6 --version
     python2.7 --version
 
-On Windows or Mac, you can download Python 2.6 here:
-    http://www.python.org/download/releases/2.6.6/
-
-or Python 2.7 here:
-    http://www.python.org/download/releases/2.7.5/
+On Windows or Mac, you can download the latest Python 2.7.x here:
+    https://www.python.org/downloads/
 
 Download the .msi installer for Windows or the .dmg archive for Mac.
 Open and run the installer using all the default options.
 
 
 INSTALLATION
 ------------
-Download and save the about.py file from:
-https://raw.github.com/dejacode/about-code-tool/master/about.py
+Checkout or download and extract the AboutCode tool from:
+    https://github.com/dejacode/about-code-tool/
+
+To install all the needed dependencies in a virtualenv, run (on posix)::
+    source configure 
+or on windows::
+    configure
 
 
 TESTS
 -----
-Optionally, to verify that everything works fine you can run the test suite,
-download the whole repository at:
-https://github.com/dejacode/about-code-tool/archive/master.zip
-
-Then open a terminal or command prompt, extract the download if needed and run::
-
+To verify that everything works fine you can run the test suite with::
     python setup.py test
 
 
@@ -150,13 +147,15 @@ information will be saved to the CSV file named "thirdparty_about.csv".
                             Example syntax:
                             genabout.py --extract_license --api_url='api_url' --api_username='api_username' --api_key='api_key'
 
+
 Example::
 
     $ python genabout.py thirdparty_code.csv /tmp/thirdparty_about/
 
 In this example, the tool will look at the "thirdparty_code.csv" and generate
 the .ABOUT files in the directory /tmp/thirdparty_about/.
 
+
 **genattrib.py**
 
 ::
@@ -207,17 +206,17 @@ For issues, you can use:
 
 SOURCE CODE
 -----------
-The ABOUT tool is available through GitHub. For the latest version visit:
-
+AboutCode is available through GitHub. For the latest version visit:
     https://github.com/dejacode/about-code-tool
 
 
 HACKING
 -------
 We accept pull requests provided under the same license as this tool.
+You agree to the http://developercertificate.org/ 
 
 
 LICENSE
 -------
-The ABOUT tool is released under the Apache 2.0 license.
+AboutCode is released under the Apache 2.0 license.
 See (of course) the about.ABOUT file for details.

SPEC

@@ -237,10 +237,10 @@ Purpose
 Options
 -------
 
-    --template_loaction
+    --template_location
 
-        This option allows user to use its own template for Attribution Generation.
-        For instance, if the custom template the user want to use is located at:
+        This option allows you to use your own template for Attribution Generation.
+        For instance, if the custom template you want to use is located at:
         /home/custom_template/template.html
 
             $ python genattrib.py --template_location=/home/custom_template/template.html input_path output_path component_list

USAGE

@@ -1,37 +1,25 @@
-about_resource: about-code-tool/about.py
+about_resource: .
 
-name: ABOUT tool
-version: 0.8.1
+name: AboutCode
+version: 0.9.0
 
 owner: nexB Inc.
 author: Jillian Daguil, Chin Yeung Li, Philippe Ombredanne, Thomas Druez
 
-
 home_url: http://dejacode.org
-readme_file: README.rst
-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
- side-by-side with the software component that it documents.
+description: AboutCode 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. This is a small text file stored in the
+ codebase side-by-side with the documented software component.
 
 
-license_text_file: apache2.LICENSE.txt
+dje_license: apache-2.0
+license_text_file: apache-2.0.LICENSE
 license_spdx: Apache-2.0
-copyright: Copyright (c) 2013 nexB, Inc.
-
-notice:
- Copyright (c) 2013 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.
+copyright: Copyright (c) 2013-2014 nexB Inc.
+
+notice_file: NOTICE

about.ABOUT

@@ -6,36 +6,40 @@
 #   i.e.
 #   python genabout.py --mapping [Input File] [Generated Location]
 #
-#
-# The current convention is to append the '.ABOUT' after the filename, OR
-# replace the last '/' with the '.ABOUT' for directories.
-#
-#
 # Below are the fields that are needed in the genabout.py
-#   - Essential Fields: Fields that are essential for the genabout.py to execute.
+#   - Essential Fields: Fields that are essential for the ABOUT Code.
 #   - Mandatory Fields: These are the mandatory fields for the ABOUT specification. 
-#       Although the genabout.py will still be able to generate ABOUT files if these fields are blank,
+#       Although ABOUT Code will still be able to generate ABOUT files if these fields are blank,
 #       it's highly recommend to have these fields filled in.
 #
 # How to example:
 #   Assuming your input have columns "Resource", "Component", "file_name", "file_version"
 #   One should do:
 #
-#   about_resource: file_name
 #   about_file: Resource
 #   name: Component
 #   version: file_version
 #
+# In addition, if there are fields that you want to put in the ABOUT
+# files, please use the 'Custom Fields' to include these fields.
+#
+#   Note: All the Custom Field's keys will be converted to lower case and 
+#         all the spaces will be replaced by '_'
+#
+#
 #   See http://www.dejacode.org/about_spec_v0.8.1.html for more information
+#
 
 # Essential Fields
-about_resource: file_name
 about_file: Directory/Filename
 
-
 # Mandatory Fields
 name: Component
 version: Confirmed Version
 
 # Optional Fields
-copyright: Confirmed Copyright
+copyright: Confirmed Copyright
+
+
+# Custom Fields
+confirmed_license: Confirmed License

about_code_tool/MAPPING.CONFIG

@@ -1,12 +0,0 @@
-# =============================================================================
-#  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.
-# =============================================================================