scanoss 1.17.0__tar.gz → 1.17.1__tar.gz

{scanoss-1.17.0/src/scanoss.egg-info → scanoss-1.17.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scanoss
-Version: 1.17.0
+Version: 1.17.1
 Summary: Simple Python library to leverage the SCANOSS APIs
 Home-page: https://scanoss.com
 Author: SCANOSS

{scanoss-1.17.0 → scanoss-1.17.1}/src/scanoss/__init__.py

@@ -22,4 +22,4 @@
    THE SOFTWARE.
 """
 
-__version__ = "1.17.0"
+__version__ = "1.17.1"

scanoss-1.17.1/src/scanoss/data/build_date.txt

@@ -0,0 +1 @@
+date: 20241024162611, utime: 1729787171

{scanoss-1.17.0 → scanoss-1.17.1}/src/scanoss/inspection/copyleft.py

@@ -69,8 +69,8 @@ class Copyleft(PolicyCheck):
         if len(components) > 0:
             details = { 'components': components }
         return {
-            'details':  json.dumps(details, indent=2),
-            'summary': f'{len(components)} component(s) with copyleft licenses were found.'
+            'details':  f'{json.dumps(details, indent=2)}\n',
+            'summary': f'{len(components)} component(s) with copyleft licenses were found.\n'
         }
 
     def _markdown(self, components: list) -> Dict[str,Any]:
@@ -96,8 +96,8 @@ class Copyleft(PolicyCheck):
             # End license loop
         # End component loop
         return  {
-            'details': f'### Copyleft licenses\n{self.generate_table(headers,rows,centered_columns)}',
-            'summary' : f'{len(components)} component(s) with copyleft licenses were found.'
+            'details': f'### Copyleft licenses\n{self.generate_table(headers,rows,centered_columns)}\n',
+            'summary' : f'{len(components)} component(s) with copyleft licenses were found.\n'
         }
 
     def _filter_components_with_copyleft_licenses(self, components: list) -> list:

{scanoss-1.17.0 → scanoss-1.17.1}/src/scanoss/inspection/undeclared_component.py

@@ -78,8 +78,8 @@ class UndeclaredComponent(PolicyCheck):
         """
         summary = f'{len(components)} undeclared component(s) were found.\n'
         if len(components) > 0:
-            summary += (f' Add the following snippet into your `sbom.json` file \n'
-                        f' ```json \n {json.dumps(self._generate_sbom_file(components), indent=2)} ``` \n ')
+            summary += (f'Add the following snippet into your `sbom.json` file\n'
+                        f'\n```json\n{json.dumps(self._generate_sbom_file(components), indent=2)}\n```\n')
         return summary
 
     def _json(self, components: list) -> Dict[str, Any]:
@@ -93,7 +93,7 @@ class UndeclaredComponent(PolicyCheck):
         if len(components) > 0:
             details = {'components': components}
         return {
-            'details':  json.dumps(details, indent=2),
+            'details':  f'{json.dumps(details, indent=2)}\n',
             'summary': self._get_summary(components),
         }
 
@@ -111,7 +111,7 @@ class UndeclaredComponent(PolicyCheck):
             licenses = " - ".join(lic.get('spdxid', 'Unknown') for lic in component['licenses'])
             rows.append([component['purl'], component['version'], licenses])
         return  {
-            'details': f'### Undeclared components\n{self.generate_table(headers,rows)}',
+            'details': f'### Undeclared components\n{self.generate_table(headers,rows)}\n',
             'summary': self._get_summary(components),
         }
 

scanoss-1.17.1/src/scanoss/inspection/utils/markdown_utils.py

@@ -0,0 +1,23 @@
+def generate_table(headers, rows, centered_columns=None):
+    """
+     Generate Markdown table
+     :param headers: List of headers
+     :param rows: Rows
+     :param centered_columns: List with centered columns
+     """
+    COL_SEP = ' | '
+    centered_column_set = set(centered_columns or [])
+    def create_separator(header, index):
+        if centered_columns is None:
+            return '-'
+        return ':-:' if index in centered_column_set else '-'
+
+    row_separator = COL_SEP + COL_SEP.join(
+        create_separator(header, index) for index, header in enumerate(headers)
+    ) + COL_SEP
+
+    table_rows = [COL_SEP + COL_SEP.join(headers) + COL_SEP]
+    table_rows.append(row_separator)
+    table_rows.extend(COL_SEP + COL_SEP.join(row) + COL_SEP for row in rows)
+
+    return '\n'.join(table_rows)

scanoss-1.17.1/src/scanoss/inspection/utils/result_utils.py

@@ -0,0 +1,79 @@
+from enum import Enum
+from typing import Dict, Any
+
+from scanoss.inspection.utils.license_utils import license_util
+
+
+class ComponentID(Enum):
+    FILE = "file"
+    SNIPPET = "snippet"
+    DEPENDENCY = "dependency"
+
+
+def _append_component(components: Dict[str, Any], new_component: Dict[str, Any]) -> Dict[str, Any]:
+    """
+    Append a new component to the components dictionary.
+
+    This function creates a new entry in the components dictionary for the given component,
+    or updates an existing entry if the component already exists. It also processes the
+    licenses associated with the component.
+
+    :param components: The existing dictionary of components
+    :param new_component: The new component to be added or updated
+    :return: The updated components dictionary
+    """
+    component_key = f"{new_component['purl'][0]}@{new_component['version']}"
+    components[component_key] = {
+        'purl': new_component['purl'][0],
+        'version': new_component['version'],
+        'licenses': {},
+        'status': new_component['status'],
+    }
+
+    # Process licenses for this component
+    for l in new_component['licenses']:
+        spdxid = l['name']
+        components[component_key]['licenses'][spdxid] = {
+            'spdxid': spdxid,
+            'copyleft': license_util.is_copyleft(spdxid),
+            'url': l.get('url')
+        }
+
+    return components
+
+
+def get_components(results: Dict[str, Any]) -> list:
+    """
+        Process the results dictionary to extract and format component information.
+
+        This function iterates through the results dictionary, identifying components from
+        different sources (files, snippets, and dependencies). It consolidates this information
+        into a list of unique components, each with its associated licenses and other details.
+
+        :param results: A dictionary containing the raw results of a component scan
+        :return: A list of dictionaries, each representing a unique component with its details
+    """
+    components = {}
+    for component in results.values():
+        for c in component:
+            if c['id'] in [ComponentID.FILE.value, ComponentID.SNIPPET.value]:
+                component_key = f"{c['purl'][0]}@{c['version']}"
+
+                # Initialize or update the component entry
+                if component_key not in components:
+                    components = _append_component(components, c)
+
+            if c['id'] == ComponentID.DEPENDENCY.value:
+                for d in c['dependencies']:
+                    component_key = f"{d['purl'][0]}@{d['version']}"
+
+                    if component_key not in components:
+                        components = _append_component(components, d)
+                # End of for loop
+            # End if
+        # End if
+    results = list(components.values())
+    for component in results:
+        component['licenses'] = list(component['licenses'].values())
+
+    return results

{scanoss-1.17.0 → scanoss-1.17.1/src/scanoss.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scanoss
-Version: 1.17.0
+Version: 1.17.1
 Summary: Simple Python library to leverage the SCANOSS APIs
 Home-page: https://scanoss.com
 Author: SCANOSS

{scanoss-1.17.0 → scanoss-1.17.1}/src/scanoss.egg-info/SOURCES.txt

@@ -68,4 +68,6 @@ src/scanoss/inspection/__init__.py
 src/scanoss/inspection/copyleft.py
 src/scanoss/inspection/policy_check.py
 src/scanoss/inspection/undeclared_component.py
-src/scanoss/inspection/utils/license_utils.py
+src/scanoss/inspection/utils/license_utils.py
+src/scanoss/inspection/utils/markdown_utils.py
+src/scanoss/inspection/utils/result_utils.py

scanoss-1.17.0/src/scanoss/data/build_date.txt

@@ -1 +0,0 @@
-date: 20241023122954, utime: 1729686594