Google compliant option with -gc. Header Reference, Logos. Fixes #775, #594 , #564 , #563, #555 , #597 , #725 , #610

.github/workflows/action-test-before-PR.yml

@@ -8,15 +8,18 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy: 
+      matrix: 
+        python-version: ["3.11", "3.12"]
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
 
       - name: Set up Python
         uses: actions/setup-python@v2
-        with:
-          python-version: "3.11"
+        with: 
+          python-version: ${{ matrix.python-version }}
 
       - name: Install Poetry
         run: curl -sSL https://install.python-poetry.org | python3 -

README.md

@@ -55,6 +55,7 @@ Given a readme file (or a GitHub/Gitlab repository) SOMEF will extract the follo
 - **Keywords**: set of terms used to commonly identify a software component
 - **License**: License and usage terms of a software component
 - **Logo**: Main logo used to represent the target software component
+- **Maintainer**: Individuals or teams responsible for maintaining the software component, extracted from the CODEOWNERS file
 - **Name**: Name identifying a software component
 - **Ontologies**: URL and path to the ontology files present in the repository
 - **Owner**: Name and type of the user or organization in charge of the repository
@@ -290,17 +291,21 @@ Options:
     -d, --doc_src PATH            Path to the README file source
     -i, --in_file PATH            A file of newline separated links to GitHub/
                                   Gitlab repositories
+    -l, --local_repo PATH         Path to the local repository source. No APIs will be used
 
   Output: [required_any]
     -o, --output PATH             Path to the output file. If supplied, the
                                   output will be in JSON
-
     -c, --codemeta_out PATH       Path to an output codemeta file
     -g, --graph_out PATH          Path to the output Knowledge Graph export
                                   file. If supplied, the output will be a
                                   Knowledge Graph, in the format given in the
                                   --format option chosen (turtle, json-ld)
-
+    -gc, --google_codemeta_out PATH Path to a Google-compliant Codemeta JSON-LD
+                                    file. This output transforms the standard
+                                    Codemeta to follow Google’s expected JSON-LD
+                                    structure.
+
   -f, --graph_format [turtle|json-ld]
                                   If the --graph_out option is given, this is
                                   the format that the graph will be stored in
@@ -325,6 +330,12 @@ Options:
   -v, --requirements_v            Export only requirements from structured
                                   sources (pom.xml, requirements.txt, etc.)
 
+
+  -ra, --reconcile_authors         SOMEF will extract additional information 
+                                  from certain files like CODEOWNERS. 
+                                  This may require extra API
+                                  requests and increase execution time
+
   -h, --help                      Show this message and exit.
 ```
 

docs/bower.md

@@ -13,10 +13,9 @@ These fields are defined in the [Bower specification](https://github.com/bower/s
 | requirements - value          |     requirements[i].result.value      | "dependencies": {"paq":"version"}  -> paq: version    *(1)* | 
 | requirements - name           |     requirements[i].result.name       | "dependencies": {"paq":"version"}  -> paq       |        
 | requirements - version            |     requirements[i].result.version    | "dependencies": {"paq":"version"}  -> version |
-| requirements - dependency type           |     requirements[i].result.dependency_type            | dependencies -> runtime , devDependencies -> dev |
 | version                 |     version[i].result.value           | version |
 
-
+<!-- | requirements - dependency type           |     requirements[i].result.dependency_type            | dependencies -> runtime , devDependencies -> dev | -->
 ---
 
 *(1)*  
@@ -36,4 +35,4 @@ These fields are defined in the [Bower specification](https://github.com/bower/s
   - Result value: "jquery: ^3.1.1"
   - Result name": "jquery"
   - Result version": "^3.1.1"
-  - Result dependency_type": "runtime" because it is "dependencies"s
+  <!-- - Result dependency_type": "runtime" because it is "dependencies"s -->

docs/composer.md

@@ -20,6 +20,7 @@ These fields are defined in the [Composer.json specification](https://getcompose
 | requirements - value              |  requirements[i].result.value                  |   require.name require.version or require-dev.name reire-dev.version       |
 | requirements - name              |  requirements[i].result.name                   |   require.name or require-dev.name           |
 | requirements - version              |  requirements[i].result.version                |     require.version or require-dev.version            |
-| requirements - dependency type              |  requirements[i].result.dependency_type        |     require = runtime or require-dev = dev            |
 | version - value                   |  version[i].result.value                      |   version                    |
 | version - tag                   |  version[i].result.tag                        |   version                   |
+
+<!-- | requirements - dependency type              |  requirements[i].result.dependency_type        |     require = runtime or require-dev = dev            | -->

docs/condaenvironment.md

@@ -0,0 +1,47 @@
+The following metadata fields can be extracted from a Conda `environment.yml` or `environment.yaml` file.  
+This file format is part of the Conda environment specification and is commonly used to declare software dependencies for reproducible environments.
+
+Only dependency information is mapped, since it is the only part of the Conda environment specification that corresponds to CodeMeta could be `softwareRequirements`.  
+
+---
+
+## Extracted metadata fields
+
+| Software metadata category  | SOMEF metadata JSON path              | ENVIRONMENT.YML metadata file field     |
+|-----------------------------|---------------------------------------|------------------------------|
+| has_package_file            | has_package_file[i].result.value      | URL of the `environment.yml` file |
+| requirements - value          |     requirements[i].result.value      | dependencies | 
+| requirements - name           |     requirements[i].result.name       | dependencies extract name       |        
+| requirements - version            |     requirements[i].result.version    | dependencies extract version |
+<!-- | requirements - dependency type           |     requirements[i].result.dependency_type            | conda if dependencies or pip if dependencies/pip  *(1)* | -->
+
+
+---
+
+<!-- 
+*(1)* 
+- Example of a dependency conda and a dependency pip:
+```
+name: ldm
+dependencies:
+  - python=3.8.5
+  - pip:
+    - albumentations==0.4.3
+```
+- Result:
+```    
+    "result": {
+        "value": "python=3.8.5",
+        "name": "python",
+        "version": "3.8.5",
+        "type": "Software_application",
+        "dependency_type": "conda"
+    },
+    "result": {
+        "value": "albumentations==0.4.3",
+        "name": "albumentations",
+        "version": "0.4.3",
+        "type": "Software_application",
+        "dependency_type": "pip"
+    },
+ -->

docs/gemspec.md

@@ -14,8 +14,8 @@ These fields are defined in the [Ruby Gems specification](https://guides.rubygem
 | requirements - value              |  requirements[i].result.value                  |   requirements/add_dependency/add_development_dependency    name:version   *(6)*    |
 | requirements - name              |  requirements[i].result.name                   |  requirements/add_dependency/add_development_dependency   name    *(6)*      |
 | requirements - version             |  requirements[i].result.version                |     requirements/add_dependency/add_development_dependency  version     *(6)*      |
-| requirements - development type             |  requirements[i].result.development_type               |     add_dependency -> runtime     *(6)*     |
-| requirements - development type                |  requirements[i].result.development_type               |     add_development_dependency -> dev      *(6)*    |
+<!-- | requirements - dependency type             |  requirements[i].result.development_type               |     add_dependency -> runtime     *(6)*     |
+| requirements - dependency type                |  requirements[i].result.development_type               |     add_development_dependency -> dev      *(6)*    | -->
 
 ---
 
@@ -57,7 +57,7 @@ These fields are defined in the [Ruby Gems specification](https://guides.rubygem
 - Example:   `gem.name          = "bootstrap-datepicker-rails"`
 - Resutl: `bootstrap-datepicker-rails`
 
-*(5)* 
+*(6)* 
 - Regex1: `r'gem\.requirements\s*=\s*(\[.*?\])'`
 - Example:
 ```
@@ -75,12 +75,13 @@ spec.requirements = [
     gem.add_dependency "railties", ">= 3.0"
     gem.add_development_dependency "bundler", ">= 1.0"
 ``` 
-Result: add_depency --> type runtime; add_development_dependencyd --> type dev 
+<!-- 
+Result: add_depency -> type runtime; add_development_dependencyd -> type dev 
 ```
     [{'result': {'value': 'railties: >= 3.0', 'name': 'railties', 'version': '>= 3.0', 'type': 'Software_application', 'dependency_type': 'runtime'}, 'confidence': 1, 'technique': 'code_parser', 'source': 'https://example.org/bootstrap-datepicker-rails.gemspec'}, {'result': {'value': 'bundler: >= 1.0', 'name': 'bundler', 'version': '>= 1.0', 'type': 'Software_application', 'dependency_type': 'dev'}, 'confidence': 1, 'technique': 'code_parser', 'source': 'https://example.org/bootstrap-datepicker-rails.gemspec'}]
 ```
 
-
+-->
 
 
 

docs/output.md

@@ -98,6 +98,7 @@ SOMEF aims to recognize the following categories (in alphabetical order):
 - `keywords`: set of terms used to commonly identify a software component
 - `license`: License and usage terms of a software component
 - `logo`: Main logo used to represent the target software component.
+- `maintainer`': Individuals or teams responsible for maintaining the software component, extracted from the CODEOWNERS file
 - `name`: Name identifying a software component
 - `ontologies`: URL and path to the ontology files present in the repository.
 - `owner`: Name of the user or organization in charge of the repository

docs/publiccode.md

@@ -121,13 +121,23 @@ dependsOn:
 
 - Result PostgreSQL:
 ```
+    "result": {
+        "value": "PostgreSQL>=14.0",
+        "name": "PostgreSQL",
+        "version": ">=14.0",
+        "type": "Software_application"
+
+    },
+```
+<!-- ```
     "result": {
         "value": "PostgreSQL>=14.0",
         "name": "PostgreSQL",
         "version": ">=14.0",
         "type": "Software_application",
         "dependency_type": "runtime"
     },
-```
+``` -->
+
 
 

docs/supported_metadata_files.md

@@ -26,6 +26,8 @@ SOMEF can extract metadata from a wide range of files commonly found in software
 | `*.cabal`       | Haskell                       | Manifest file serving as the package descriptor for Haskell projects.| <div align="center">[🔍](./cabal.md)</div> | [📄](https://cabal.readthedocs.io/en/3.10/cabal-package.html)| |[Example](https://github.com/haskell/cabal/blob/master/Cabal/Cabal.cabal) |
 | `dockerfile`       | Dockerfile                       | Build specification file for container images that can include software metadata via LABEL instructions (OCI specification).| <div align="center">[🔍](./dockerfiledoc.md)</div> | [📄](https://docs.docker.com/reference/dockerfile/)| |[Example](https://github.com/FairwindsOps/nova/blob/master/Dockerfile) |
 | `publiccode.yml`       | YAML                      | YAML metadata file for public sector software projects| <div align="center">[🔍](./publiccode.md)</div> | [📄](https://yml.publiccode.tools//)| |[Example](https://github.com/maykinmedia/objects-api/blob/master/publiccode.yaml) |
+| `environment.yml`       | YAML                      | Conda environment specification file declaring software dependencies for reproducible environments| <div align="center">[🔍](./codaenvironment.md)</div> | | |[Example](https://github.com/CompVis/stable-diffusion/blob/main/environment.yaml) |
+
 
 > **Note:** The general principles behind metadata mapping in SOMEF are based on the [CodeMeta crosswalk](https://github.com/codemeta/codemeta/blob/master/crosswalk.csv) and the [CodeMeta JSON-LD context](https://github.com/codemeta/codemeta/blob/master/codemeta.jsonld).  
 > However, each supported file type may have specific characteristics and field interpretations.