# spdx/spec-parser architecture

> Architecture diagram of the GitHub repository spdx/spec-parser, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/spdx/spec-parser
- Repository: https://github.com/spdx/spec-parser

## Overview

##### Main Components

a. Input Processing Layer:
- Model Parser (spec_parser/model.py)
- Markdown Parser (spec_parser/mdparsing.py)
- Loaders (spec_parser/loaders.py)

b. Output Generation Layer:
- MkDocs Generator (spec_parser/mkdocs.py)
- JSON Dumper (spec_parser/jsondump.py)
- PlantUML Generator (spec_parser/plantuml.py)
- RDF Generator (spec_parser/rdf.py)
- TeX Generator (spec_parser/tex.py)

c. Template System:
- MkDocs Templates
- TeX Templates

**[Input Directory] → [Input Processing Layer] → [Core Model] → [Output Generation Layer] → [Output Directory]**

##### Important Details to Capture

- Command-line interface entry point (main.py)
- Configuration handling (runparams.py)
- Template system architecture showing both MkDocs and TeX templates
- Validation flow for the "check input" functionality
- Different output formats and their relationships

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Input
        InputDir[Input Directory]
    end

    subgraph "Input Processing Layer"
        Loaders["Loaders"]:::input
        MDParser["Markdown Parser"]:::input
        ModelParser["Model Parser"]:::input
    end

    subgraph "Core Processing"
        CoreModel["Core Model"]:::core
        Config["Configuration Handler"]:::core
        MainEntry["Main Entry Point"]:::core
    end

    subgraph "Output Generation Layer"
        MkDocsGen["MkDocs Generator"]:::output
        JSONGen["JSON Dumper"]:::output
        PlantUMLGen["PlantUML Generator"]:::output
        RDFGen["RDF Generator"]:::output
        TeXGen["TeX Generator"]:::output
    end

    subgraph "Template System"
        MkDocsTemplates[("MkDocs Templates")]:::template
        TeXTemplates[("TeX Templates")]:::template
    end

    subgraph Output
        OutputDir[Output Directory]
    end

    %% Connections
    InputDir --> Loaders
    Loaders --> ModelParser
    MDParser --> ModelParser
    ModelParser --> CoreModel
    Config --> CoreModel
    MainEntry --> CoreModel

    CoreModel --> MkDocsGen
    CoreModel --> JSONGen
    CoreModel --> PlantUMLGen
    CoreModel --> RDFGen
    CoreModel --> TeXGen

    MkDocsTemplates -.-> MkDocsGen
    TeXTemplates -.-> TeXGen

    MkDocsGen --> OutputDir
    JSONGen --> OutputDir
    PlantUMLGen --> OutputDir
    RDFGen --> OutputDir
    TeXGen --> OutputDir

    %% Styles
    classDef input fill:#a8d1f0
    classDef core fill:#90EE90
    classDef output fill:#ffb366
    classDef template fill:#d7b3ff

    %% Click events
    click Loaders "https://github.com/spdx/spec-parser/blob/main/spec_parser/loaders.py"
    click MDParser "https://github.com/spdx/spec-parser/blob/main/spec_parser/mdparsing.py"
    click ModelParser "https://github.com/spdx/spec-parser/blob/main/spec_parser/model.py"
    click MkDocsGen "https://github.com/spdx/spec-parser/blob/main/spec_parser/mkdocs.py"
    click JSONGen "https://github.com/spdx/spec-parser/blob/main/spec_parser/jsondump.py"
    click PlantUMLGen "https://github.com/spdx/spec-parser/blob/main/spec_parser/plantuml.py"
    click RDFGen "https://github.com/spdx/spec-parser/blob/main/spec_parser/rdf.py"
    click TeXGen "https://github.com/spdx/spec-parser/blob/main/spec_parser/tex.py"
    click MkDocsTemplates "https://github.com/spdx/spec-parser/tree/main/spec_parser/templates/mkdocs/"
    click TeXTemplates "https://github.com/spdx/spec-parser/tree/main/spec_parser/templates/tex/"
    click MainEntry "https://github.com/spdx/spec-parser/blob/main/main.py"
    click Config "https://github.com/spdx/spec-parser/blob/main/runparams.py"

    %% Legend
    subgraph Legend
        L1[Input Processing]:::input
        L2[Core Processing]:::core
        L3[Output Generation]:::output
        L4[("Templates")]:::template
    end
```
