# juanjemdios/somef architecture

> Architecture diagram of the GitHub repository juanjemdios/somef, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/juanjemdios/somef
- Repository: https://github.com/juanjemdios/somef

## Overview

SOMEF is a command-line framework that extracts structured software metadata from repository READMEs, configuration files, and repository-hosting services. The principal workflow is repository input, file-level extraction, normalization into provenance-bearing results, and export. The graph also preserves documented extraction capabilities such as ontologies, workflows, software-type classification, and enrichment. Several internal connections are supported by the SOURCE INDEX; unsampled CLI and integration wiring is not inferred.

Main entry points: [`src/somef/process_files.py`](https://github.com/juanjemdios/somef/blob/master/src/somef/process_files.py) (File processing), [`src/somef/process_repository.py`](https://github.com/juanjemdios/somef/blob/master/src/somef/process_repository.py) (Repository processing), [`src/somef/parser`](https://github.com/juanjemdios/somef/tree/master/src/somef/parser) (Metadata parsers), [`src/somef/process_results.py`](https://github.com/juanjemdios/somef/blob/master/src/somef/process_results.py) (Result model)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Entry and repository access"]
  node_cli["Command-line interface<br/>[somef_cli.py]"]
  node_repo["Repository processing"]
end

subgraph group_extract["Metadata extraction"]
  node_file_scan["File processing<br/>[process_files.py]"]
  node_header["README analysis<br/>[header_analysis.py]"]
  node_parsers["Metadata parsers"]
  node_regex["Pattern extraction"]
  node_software_type["Software type"]
  node_ontology["Ontology extraction"]
  node_workflows["Workflow extraction"]
end

subgraph group_model["Results and enrichment"]
  node_configuration["Configuration<br/>[configuration.py]"]
  node_results["Result model<br/>[process_results.py]"]
  node_constants["Metadata vocabulary<br/>[constants.py]"]
  node_enrichment["Metadata enrichment<br/>[enrichment.py]"]
end

subgraph group_output["Export formats"]
  node_json_export["JSON export<br/>[json_export.py]"]
  node_turtle_export["Turtle export<br/>[turtle_export.py]"]
  node_codemeta_export["CodeMeta export"]
end

node_user(("Repository user"))
node_external_services{{"Repository services"}}

node_user -->|"requests extraction"| node_cli
node_user -->|"provides repository"| node_repo
node_repo -->|"uses settings"| node_configuration
node_repo -->|"records metadata"| node_results
node_repo -.->|"queries hosts"| node_external_services
node_file_scan -->|"dispatches parsing"| node_parsers
node_file_scan -->|"extracts ontologies"| node_ontology
node_file_scan -->|"extracts workflows"| node_workflows
node_file_scan -->|"adds results"| node_results
node_header -->|"uses Markdown parser"| node_parsers
node_header -->|"records findings"| node_results
node_parsers -->|"creates results"| node_results
node_parsers -->|"uses vocabulary"| node_constants
node_header -->|"uses patterns"| node_regex
node_configuration -->|"uses constants"| node_constants
node_enrichment -.->|"enriches metadata"| node_external_services
node_json_export -->|"maps categories"| node_constants
node_turtle_export -->|"uses vocabulary"| node_constants

click node_cli "https://github.com/juanjemdios/somef/blob/master/src/somef/somef_cli.py"
click node_repo "https://github.com/juanjemdios/somef/blob/master/src/somef/process_repository.py"
click node_file_scan "https://github.com/juanjemdios/somef/blob/master/src/somef/process_files.py"
click node_header "https://github.com/juanjemdios/somef/blob/master/src/somef/header_analysis.py"
click node_parsers "https://github.com/juanjemdios/somef/tree/master/src/somef/parser"
click node_regex "https://github.com/juanjemdios/somef/blob/master/src/somef/regular_expressions.py"
click node_software_type "https://github.com/juanjemdios/somef/blob/master/src/somef/extract_software_type.py"
click node_ontology "https://github.com/juanjemdios/somef/blob/master/src/somef/extract_ontologies.py"
click node_workflows "https://github.com/juanjemdios/somef/blob/master/src/somef/extract_workflows.py"
click node_configuration "https://github.com/juanjemdios/somef/blob/master/src/somef/configuration.py"
click node_results "https://github.com/juanjemdios/somef/blob/master/src/somef/process_results.py"
click node_constants "https://github.com/juanjemdios/somef/blob/master/src/somef/utils/constants.py"
click node_enrichment "https://github.com/juanjemdios/somef/blob/master/src/somef/utils/enrichment.py"
click node_json_export "https://github.com/juanjemdios/somef/blob/master/src/somef/export/json_export.py"
click node_turtle_export "https://github.com/juanjemdios/somef/blob/master/src/somef/export/turtle_export.py"
click node_codemeta_export "https://github.com/juanjemdios/somef/blob/master/src/somef/export/google_codemeta_export.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_repo,node_user toneBlue
class node_file_scan,node_header,node_parsers,node_regex,node_software_type,node_ontology,node_workflows toneAmber
class node_configuration,node_results,node_constants,node_enrichment toneMint
class node_json_export,node_turtle_export,node_codemeta_export toneRose
class node_external_services toneIndigo
```

## Components

### Entry and repository access

- [Command-line interface](https://github.com/juanjemdios/somef/blob/master/src/somef/somef_cli.py): `src/somef/somef_cli.py`
- [Repository processing](https://github.com/juanjemdios/somef/blob/master/src/somef/process_repository.py): `src/somef/process_repository.py`

### Metadata extraction

- [File processing](https://github.com/juanjemdios/somef/blob/master/src/somef/process_files.py): `src/somef/process_files.py`
- [README analysis](https://github.com/juanjemdios/somef/blob/master/src/somef/header_analysis.py): `src/somef/header_analysis.py`
- [Metadata parsers](https://github.com/juanjemdios/somef/tree/master/src/somef/parser): `src/somef/parser`
- [Pattern extraction](https://github.com/juanjemdios/somef/blob/master/src/somef/regular_expressions.py): `src/somef/regular_expressions.py`
- [Software type](https://github.com/juanjemdios/somef/blob/master/src/somef/extract_software_type.py): `src/somef/extract_software_type.py`
- [Ontology extraction](https://github.com/juanjemdios/somef/blob/master/src/somef/extract_ontologies.py): `src/somef/extract_ontologies.py`
- [Workflow extraction](https://github.com/juanjemdios/somef/blob/master/src/somef/extract_workflows.py): `src/somef/extract_workflows.py`

### Results and enrichment

- [Configuration](https://github.com/juanjemdios/somef/blob/master/src/somef/configuration.py): `src/somef/configuration.py`
- [Result model](https://github.com/juanjemdios/somef/blob/master/src/somef/process_results.py): `src/somef/process_results.py`
- [Metadata vocabulary](https://github.com/juanjemdios/somef/blob/master/src/somef/utils/constants.py): `src/somef/utils/constants.py`
- [Metadata enrichment](https://github.com/juanjemdios/somef/blob/master/src/somef/utils/enrichment.py): `src/somef/utils/enrichment.py`

### Export formats

- [JSON export](https://github.com/juanjemdios/somef/blob/master/src/somef/export/json_export.py): `src/somef/export/json_export.py`
- [Turtle export](https://github.com/juanjemdios/somef/blob/master/src/somef/export/turtle_export.py): `src/somef/export/turtle_export.py`
- [CodeMeta export](https://github.com/juanjemdios/somef/blob/master/src/somef/export/google_codemeta_export.py): `src/somef/export/google_codemeta_export.py`

### Other components

- **Repository user**
- **Repository services**

## Connections

- Repository user → Command-line interface: requests extraction (evidence: `README.md`)
- Repository user → Repository processing: provides repository (evidence: `README.md`)
- Repository processing → Configuration: uses settings (evidence: `src/somef/process_repository.py`)
- Repository processing → Result model: records metadata (evidence: `src/somef/process_repository.py`)
- Repository processing → Repository services: queries hosts
- File processing → Metadata parsers: dispatches parsing (evidence: `src/somef/process_files.py`)
- File processing → Ontology extraction: extracts ontologies (evidence: `src/somef/process_files.py`)
- File processing → Workflow extraction: extracts workflows (evidence: `src/somef/process_files.py`)
- File processing → Result model: adds results (evidence: `src/somef/process_files.py`)
- README analysis → Metadata parsers: uses Markdown parser (evidence: `src/somef/header_analysis.py`)
- README analysis → Result model: records findings (evidence: `src/somef/header_analysis.py`)
- Metadata parsers → Result model: creates results (evidence: `src/somef/parser/codemeta_parser.py`)
- Metadata parsers → Metadata vocabulary: uses vocabulary (evidence: `src/somef/parser/codemeta_parser.py`)
- README analysis → Pattern extraction: uses patterns (evidence: `src/somef/header_analysis.py`)
- Configuration → Metadata vocabulary: uses constants (evidence: `src/somef/configuration.py`)
- Metadata enrichment → Repository services: enriches metadata
- JSON export → Metadata vocabulary: maps categories (evidence: `src/somef/export/json_export.py`)
- Turtle export → Metadata vocabulary: uses vocabulary (evidence: `src/somef/export/turtle_export.py`)
