Merge pull request #1868 from Gaupeng/develop

Add OSI License Key Mappings

Author: pombredanne

etc/scripts/osikeys.py

@@ -0,0 +1,52 @@
+import json
+import licensedcode.index
+import urllib.request
+from licensedcode.cache import get_index
+from licensedcode.models import load_licenses
+
+
+def find_osi_map(license: "OSI License Object"):
+    """
+    Return Scancode key mapped to OSI License `license`
+    """
+    idx = get_index()
+    osi_key = license['id']
+    # search for Scancode License matching OSI Key
+    matches = list(idx.match(query_string = osi_key))
+    if not matches:
+        return None
+    return matches[0].rule.license_expression
+
+
+def add_osi_key(obj: "OSI License Object"):
+    """
+    Add OSI License Key derived from OSI License Object `obj`
+    """
+    licenses = licensedcode.cache.get_licenses_db()
+    # find matching Scancode License Object for `obj`
+    result = find_osi_map(obj) 
+    # derive OSI License Key from `obj`
+    osi_key = obj['id'] 
+    if not result: # no matching Scancode License found
+        return None 
+    mapped_license = licenses[result] # license object from Scancode
+    licenses_path = "src/licensedcode/data/licenses/" # licenses directory
+    file_to_modify = open(licenses_path + mapped_license.key + ".yml", "a")
+    file_to_modify.write("osi_license_key: " + osi_key)
+    file_to_modify.write("\n")
+
+
+def add_osi_keys():
+    """
+    For every possible OSI License, match and add OSI Key to existing Scancode License
+    """
+    #retrieve OSI License Objects
+    contents = urllib.request.urlopen("https://api.opensource.org/licenses/").read().decode()
+    data = json.loads(contents)
+    # for each OSI License Object, update matching Scancode License Object
+    for obj in data:
+        add_osi_key(obj)
+    
+
+if __name__ == '__main__':
+    add_osi_keys()

src/licensedcode/data/licenses/adapt-1.0.yml

@@ -12,3 +12,4 @@ osi_url: http://www.opensource.org/licenses/apl1.0.php
 other_urls:
     - http://www.opensource.org/licenses/APL-1.0
     - https://opensource.org/licenses/APL-1.0
+osi_license_key: APL-1.0

src/licensedcode/data/licenses/afl-3.0.yml

@@ -19,3 +19,4 @@ ignorable_copyrights:
     - Copyright (c) 2005 Lawrence Rosen
 ignorable_holders:
     - Lawrence Rosen
+osi_license_key: AFL-3.0

src/licensedcode/data/licenses/agpl-3.0.yml

@@ -27,3 +27,4 @@ ignorable_holders:
 ignorable_urls:
     - https://fsf.org/
     - https://www.gnu.org/licenses/
+osi_license_key: AGPL-3.0

src/licensedcode/data/licenses/apache-1.1.yml

@@ -24,3 +24,4 @@ ignorable_urls:
     - http://www.apache.org/
 ignorable_emails:
     - apache@apache.org
+osi_license_key: Apache-1.1

src/licensedcode/data/licenses/apache-2.0.yml

@@ -18,3 +18,4 @@ other_urls:
 ignorable_urls:
     - http://www.apache.org/licenses/
     - http://www.apache.org/licenses/LICENSE-2.0
+osi_license_key: Apache-2.0

src/licensedcode/data/licenses/apsl-2.0.yml

@@ -19,3 +19,4 @@ ignorable_holders:
 ignorable_urls:
     - http://www.apple.com/legal/guidelinesfor3rdparties.html
     - http://www.opensource.apple.com/apsl/
+osi_license_key: APSL-2.0

src/licensedcode/data/licenses/artistic-1.0.yml

@@ -16,3 +16,4 @@ other_urls:
     - https://opensource.org/licenses/Artistic-1.0
 ignorable_urls:
     - http://ftp.uu.net/
+osi_license_key: Artistic-1.0

src/licensedcode/data/licenses/artistic-2.0.yml

@@ -22,3 +22,4 @@ ignorable_authors:
     - The Perl Foundation
 ignorable_holders:
     - The Perl Foundation
+osi_license_key: Artistic-2.0

src/licensedcode/data/licenses/bsd-new.yml

@@ -12,3 +12,4 @@ osi_url: http://www.opensource.org/licenses/BSD-3-Clause
 other_urls:
     - http://framework.zend.com/license/new-bsd
     - https://opensource.org/licenses/BSD-3-Clause
+osi_license_key: BSD-3