How knowledgecaptureanddiscovery/somef works
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: process_results.py Metadata results · process_files.py File exploration · process_repository.py Repository metadata · header_analysis.py README analysis
Components 19
User entry
- Command-line interface
src/somef/somef_cli.py
Repository extraction
- Repository metadata
src/somef/process_repository.py - File exploration
src/somef/process_files.py - Extraction configuration
src/somef/configuration.py
Metadata analysis
- README analysis
src/somef/header_analysis.py - Markdown parsing
src/somef/parser/mardown_parser.py - Metadata file parsers
src/somef/parser - Author extraction
src/somef/parser/authors_parser.py - Pattern extraction
src/somef/regular_expressions.py - Software type
src/somef/extract_software_type.py - Ontology extraction
src/somef/extract_ontologies.py - Workflow extraction
src/somef/extract_workflows.py - Supervised classification
src/somef/supervised_classification.py
Results and export
- Metadata results
src/somef/process_results.py - Metadata enrichment
src/somef/utils/enrichment.py - JSON export
src/somef/export/json_export.py - Turtle export
src/somef/export/turtle_export.py - CodeMeta export
src/somef/export/google_codemeta_export.py
Other components
- CLI user
Connections 20
- CLI user → Command-line interface: invokes
README.md - Command-line interface → Repository metadata: requests extraction
- Command-line interface → File exploration: requests extraction
- File exploration → Metadata file parsers: dispatches parsing
src/somef/process_files.py - File exploration → Ontology extraction: calls
src/somef/process_files.py - File exploration → Workflow extraction: calls
src/somef/process_files.py - File exploration → Metadata results: records findings
src/somef/process_files.py - Repository metadata → Extraction configuration: uses settings
src/somef/process_repository.py - Repository metadata → Metadata results: records findings
src/somef/process_repository.py - README analysis → Markdown parsing: uses parsing
src/somef/header_analysis.py - README analysis → Pattern extraction: uses patterns
src/somef/header_analysis.py - README analysis → Metadata results: records findings
src/somef/header_analysis.py - Metadata file parsers → Metadata results: builds results
src/somef/parser/codemeta_parser.py - Author extraction → Metadata results: adds authors
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