# knowledgecaptureanddiscovery/somef architecture

> Architecture diagram of the GitHub repository knowledgecaptureanddiscovery/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/knowledgecaptureanddiscovery/somef
- Repository: https://github.com/knowledgecaptureanddiscovery/somef

## Overview

SOMEF is a command-line framework that extracts structured software metadata from repository READMEs, configuration files, and repository-host information. Its main workflow accepts a repository or README, explores files and repository metadata, applies specialized parsers and README analysis, collects findings with provenance, and exports JSON or linked-data formats. The README documents additional extraction capabilities such as software-type, ontology, workflow, and metadata enrichment. Some implementation details are unsampled, so links to those capabilities are shown only where documented or referenced in the source index.

Main entry points: [`src/somef/process_results.py`](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/process_results.py) (Metadata results), [`src/somef/process_files.py`](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/process_files.py) (File exploration), [`src/somef/process_repository.py`](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/process_repository.py) (Repository metadata), [`src/somef/header_analysis.py`](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/header_analysis.py) (README analysis)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User entry"]
  node_cli["Command-line interface<br/>[somef_cli.py]"]
end

subgraph group_extraction["Repository extraction"]
  node_repo["Repository metadata"]
  node_files["File exploration<br/>[process_files.py]"]
  node_config["Extraction configuration<br/>[configuration.py]"]
end

subgraph group_analysis["Metadata analysis"]
  node_readme["README analysis<br/>[header_analysis.py]"]
  node_markdown["Markdown parsing<br/>[mardown_parser.py]"]
  node_parsers["Metadata file parsers"]
  node_authors["Author extraction<br/>[authors_parser.py]"]
  node_patterns["Pattern extraction"]
  node_software_type["Software type"]
  node_ontologies["Ontology extraction"]
  node_workflows["Workflow extraction"]
  node_classifier["Supervised classification"]
end

subgraph group_output["Results and export"]
  node_results["Metadata results<br/>[process_results.py]"]
  node_enrichment["Metadata enrichment<br/>[enrichment.py]"]
  node_json["JSON export<br/>[json_export.py]"]
  node_turtle["Turtle export<br/>[turtle_export.py]"]
  node_codemeta["CodeMeta export"]
end

node_user(("CLI user"))

node_user -->|"invokes"| node_cli
node_cli -.->|"requests extraction"| node_repo
node_cli -.->|"requests extraction"| node_files
node_files -->|"dispatches parsing"| node_parsers
node_files -->|"calls"| node_ontologies
node_files -->|"calls"| node_workflows
node_files -->|"records findings"| node_results
node_repo -->|"uses settings"| node_config
node_repo -->|"records findings"| node_results
node_readme -->|"uses parsing"| node_markdown
node_readme -->|"uses patterns"| node_patterns
node_readme -->|"records findings"| node_results
node_parsers -->|"builds results"| node_results
node_authors -->|"adds authors"| node_results
node_results -.->|"exports JSON"| node_json
node_results -.->|"exports RDF"| node_turtle
node_results -.->|"exports CodeMeta"| node_codemeta
node_repo -.->|"enriches metadata"| node_enrichment
node_files -.->|"detects type"| node_software_type
node_files -.->|"classifies content"| node_classifier

click node_cli "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/somef_cli.py"
click node_repo "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/process_repository.py"
click node_files "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/process_files.py"
click node_config "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/configuration.py"
click node_readme "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/header_analysis.py"
click node_markdown "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/parser/mardown_parser.py"
click node_parsers "https://github.com/knowledgecaptureanddiscovery/somef/tree/master/src/somef/parser"
click node_authors "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/parser/authors_parser.py"
click node_patterns "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/regular_expressions.py"
click node_software_type "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/extract_software_type.py"
click node_ontologies "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/extract_ontologies.py"
click node_workflows "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/extract_workflows.py"
click node_classifier "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/supervised_classification.py"
click node_results "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/process_results.py"
click node_enrichment "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/utils/enrichment.py"
click node_json "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/export/json_export.py"
click node_turtle "https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/export/turtle_export.py"
click node_codemeta "https://github.com/knowledgecaptureanddiscovery/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_user toneBlue
class node_repo,node_files,node_config toneAmber
class node_readme,node_markdown,node_parsers,node_authors,node_patterns,node_software_type,node_ontologies,node_workflows,node_classifier toneMint
class node_results,node_enrichment,node_json,node_turtle,node_codemeta toneRose
```

## Components

### User entry

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

### Repository extraction

- [Repository metadata](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/process_repository.py): `src/somef/process_repository.py`
- [File exploration](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/process_files.py): `src/somef/process_files.py`
- [Extraction configuration](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/configuration.py): `src/somef/configuration.py`

### Metadata analysis

- [README analysis](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/header_analysis.py): `src/somef/header_analysis.py`
- [Markdown parsing](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/parser/mardown_parser.py): `src/somef/parser/mardown_parser.py`
- [Metadata file parsers](https://github.com/knowledgecaptureanddiscovery/somef/tree/master/src/somef/parser): `src/somef/parser`
- [Author extraction](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/parser/authors_parser.py): `src/somef/parser/authors_parser.py`
- [Pattern extraction](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/regular_expressions.py): `src/somef/regular_expressions.py`
- [Software type](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/extract_software_type.py): `src/somef/extract_software_type.py`
- [Ontology extraction](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/extract_ontologies.py): `src/somef/extract_ontologies.py`
- [Workflow extraction](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/extract_workflows.py): `src/somef/extract_workflows.py`
- [Supervised classification](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/supervised_classification.py): `src/somef/supervised_classification.py`

### Results and export

- [Metadata results](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/process_results.py): `src/somef/process_results.py`
- [Metadata enrichment](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/utils/enrichment.py): `src/somef/utils/enrichment.py`
- [JSON export](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/export/json_export.py): `src/somef/export/json_export.py`
- [Turtle export](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/export/turtle_export.py): `src/somef/export/turtle_export.py`
- [CodeMeta export](https://github.com/knowledgecaptureanddiscovery/somef/blob/master/src/somef/export/google_codemeta_export.py): `src/somef/export/google_codemeta_export.py`

### Other components

- **CLI user**

## Connections

- CLI user → Command-line interface: invokes (evidence: `README.md`)
- Command-line interface → Repository metadata: requests extraction
- Command-line interface → File exploration: requests extraction
- File exploration → Metadata file parsers: dispatches parsing (evidence: `src/somef/process_files.py`)
- File exploration → Ontology extraction: calls (evidence: `src/somef/process_files.py`)
- File exploration → Workflow extraction: calls (evidence: `src/somef/process_files.py`)
- File exploration → Metadata results: records findings (evidence: `src/somef/process_files.py`)
- Repository metadata → Extraction configuration: uses settings (evidence: `src/somef/process_repository.py`)
- Repository metadata → Metadata results: records findings (evidence: `src/somef/process_repository.py`)
- README analysis → Markdown parsing: uses parsing (evidence: `src/somef/header_analysis.py`)
- README analysis → Pattern extraction: uses patterns (evidence: `src/somef/header_analysis.py`)
- README analysis → Metadata results: records findings (evidence: `src/somef/header_analysis.py`)
- Metadata file parsers → Metadata results: builds results (evidence: `src/somef/parser/codemeta_parser.py`)
- Author extraction → Metadata results: adds authors (evidence: `src/somef/parser/authors_parser.py`)
- Metadata results → JSON export: exports JSON
- Metadata results → Turtle export: exports RDF
- Metadata results → CodeMeta export: exports CodeMeta
- Repository metadata → Metadata enrichment: enriches metadata
- File exploration → Software type: detects type
- File exploration → Supervised classification: classifies content
