License scanner

gimie/__init__.py

@@ -2,13 +2,13 @@
 # Copyright 2022 - Swiss Data Science Center (SDSC)
 # A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
 # Eidgenössische Technische Hochschule Zürich (ETHZ).
-# 
+#
 # 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.

gimie/sources/files.py

@@ -2,18 +2,55 @@
 # Copyright 2022 - Swiss Data Science Center (SDSC)
 # A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
 # Eidgenössische Technische Hochschule Zürich (ETHZ).
-# 
+#
 # 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.
+import os
+import re
+
+from typing import List
+
+
 class FilesMetadata:
-    def __init__(self, path: str):
-        raise NotImplementedError
+    """This classes provides helpers to navigate and read metadata files
+    from a project directory.
+
+    Examples
+    --------
+    >>> FilesMetadata('.').locate_licenses()
+    ['./LICENSE']
+    """
+
+    def __init__(self, project_path: str):
+        self.project_path = project_path
+
+    def locate_licenses(self) -> List[str]:
+        """Returns valid potential paths to license files in the project.
+        This uses pattern-matching on file names.
+        """
+        license_files = []
+        pattern = r".*(license(s)?|reus(e|ing)|copy(ing)?)(\.(txt|md|rst))?$"
+        for root, _, files in os.walk(self.project_path):
+            # skip toplevel hidden dirs (e.g. .git/)
+            subdir = os.path.relpath(root, self.project_path)
+            if subdir.startswith(".") and subdir != ".":
+                continue
+            for file in files:
+                # skip hidden files
+                if file.startswith("."):
+                    continue
+
+                if re.match(pattern, file, flags=re.IGNORECASE):
+                    license_path = os.path.join(root, file)
+                    license_files.append(license_path)
+
+        return license_files

gimie/sources/git.py

@@ -66,7 +66,12 @@ def __init__(self, path: str):
     @cached_property
     def authors(self) -> Tuple[str]:
         """Get the authors of the repository."""
-        return tuple(set(commit.author.name for commit in self.repository.traverse_commits()))
+        return tuple(
+            set(
+                commit.author.name
+                for commit in self.repository.traverse_commits()
+            )
+        )
 
     @cached_property
     def creation_date(self) -> Optional[datetime.datetime]:
@@ -90,8 +95,14 @@ def releases(self) -> Tuple[Release]:
         try:
             # This is necessary to initialize the repository
             next(self.repository.traverse_commits())
-            releases = tuple(Release(tag=tag.name, date=tag.commit.authored_datetime,
-                                     commit_hash=tag.commit.hexsha) for tag in self.repository.git.repo.tags)
+            releases = tuple(
+                Release(
+                    tag=tag.name,
+                    date=tag.commit.authored_datetime,
+                    commit_hash=tag.commit.hexsha,
+                )
+                for tag in self.repository.git.repo.tags
+            )
             return sorted(releases)
         except StopIteration:
             return None

gimie/sources/license.py

@@ -2,18 +2,61 @@
 # Copyright 2022 - Swiss Data Science Center (SDSC)
 # A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
 # Eidgenössische Technische Hochschule Zürich (ETHZ).
-# 
+#
 # 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.
+
+from typing import List, Tuple
+from scancode.api import get_licenses
+
+
 class LicenseMetadata:
-    def __init__(self, path: str):
-        raise NotImplementedError
+    """
+    This class provides metadata about software licenses.
+    It requires paths to files containing the license text.
+
+    Attributes
+    ----------
+    paths:
+        The collection of paths containing license information.
+
+    Examples
+    --------
+    >>> LicenseMetadata('./LICENSE').get_licenses()
+    ['https://spdx.org/licenses/Apache-2.0']
+    """
+
+    def __init__(self, *paths: str):
+            self.paths: Tuple[str] = paths
+
+    def get_licenses(self, min_score: int = 50) -> List[str]:
+        """Returns the SPDX URLs of detected licenses.
+        Performs a diff comparison between file contents and a
+        database of licenses via the scancode API.
+
+        Parameters
+        ----------
+        min_score:
+            The minimal matching score used by scancode (from 0 to 100)
+            to return a license match.
+
+        Returns
+        -------
+        licenses:
+            A list of SPDX URLs matching provided licenses,
+            e.g. https://spdx.org/licenses/Apache-2.0.html.
+        """
+        mappings = get_licenses(self.paths[0], min_score=min_score)
+        licenses = [
+            mapping["spdx_url"] for mapping in mappings.get('licenses')
+        ]
+
+        return licenses