# eli64s/splitme-ai architecture

> Architecture diagram of the GitHub repository eli64s/splitme-ai, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/eli64s/splitme-ai
- Repository: https://github.com/eli64s/splitme-ai

## Overview

##### Main Components

a. Core Processing Engine:
- Core.py module which handles the main processing logic
- To the generators and utils packages

b. Input/Output Layer:
- At the top/bottom
- File input handling (Markdown files)
- Output generation (split Markdown files and MkDocs config)

c. Utility Services:
- On the left side
- File handling, filename sanitization, and reference link management
- Connection to the core processing engine

d. CLI Interface:
- On the right side
- Connection to the core engine and settings management

##### Component Relationships

**[CLI Interface] → [Settings Manager]**
- ↓
**[Input Markdown] → [Core Processing Engine] → [Output Files]**
- ↑               ↓
**[Utility Services] ← [Generators]**

##### Detailed Component Breakdown

Core Processing Engine:

- Core Engine (core.py)|

- Section Splitting    |
- Hierarchy Handling   |
- Content Processing   |

Utility Services:

- Utils Package      |

- FileHandler          |
- FilenameSanitizer    |
- ReferenceLinks       |

Generators:

- Generators Package    |

- MkDocs Config        |
- Output Management    |

##### Key Flows to Highlight

a. Input Processing Flow:
- Markdown file input → File Handler → Core Engine → Section Splitting

b. Output Generation Flow:
- Core Engine → Generators → File Handler → Output Files

c. Configuration Flow:
- CLI → Settings → Core Engine → Generators

##### Additional Elements

- Version information
- Supported Python versions
- External dependencies
- Error handling flow

##### Implementation Notes

- Maintain consistent spacing and alignment
- Brief descriptions for each major component
- Configuration file interactions

Remember to include the project's key features like heading-level-based splitting, filename sanitization, and MkDocs integration as annotations or notes in the relevant components.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef core fill:#b3d1ff,stroke:#333
    classDef tools fill:#90EE90,stroke:#333
    classDef utils fill:#98FB98,stroke:#333
    classDef input fill:#FFA07A,stroke:#333
    classDef output fill:#DEB887,stroke:#333
    classDef generator fill:#DDA0DD,stroke:#333
    classDef testing fill:#D3D3D3,stroke:#333

    %% Input Layer
    subgraph Input
        CLI["CLI Interface"]:::input
        Config["Configuration Settings"]:::input
    end

    %% Core Processing Layer
    subgraph CoreProcessing
        MarkdownEngine["Markdown Processing Engine"]:::core
        ConfigManager["Configuration Manager"]:::core
        ErrorHandler["Error Handler"]:::core
    end

    %% Tools Layer
    subgraph Tools
        LinkConverter["Link Converter"]:::tools
        LinkValidator["Link Validator"]:::tools
        RefExtractor["Reference Extractor"]:::tools
    end

    %% Utilities Layer
    subgraph Utils
        FileHandler["File Handler"]:::utils
        FilenameSanitizer["Filename Sanitizer"]:::utils
        Logger["Logger"]:::utils
    end

    %% Generators Layer
    subgraph Generators
        MkDocsGen["MkDocs Configuration Generator"]:::generator
    end

    %% Testing Layer
    subgraph Testing
        CoreTests["Core Tests"]:::testing
        CLITests["CLI Tests"]:::testing
        TestData["Test Data"]:::testing
    end

    %% Output Layer
    subgraph Output
        SplitFiles["Split Markdown Files"]:::output
        MkDocsConfig["MkDocs Configuration"]:::output
        ValidationReport["Validation Reports"]:::output
    end

    %% Relationships
    CLI --> MarkdownEngine
    Config --> ConfigManager
    MarkdownEngine --> LinkConverter
    MarkdownEngine --> LinkValidator
    MarkdownEngine --> RefExtractor
    LinkConverter --> FileHandler
    LinkValidator --> FileHandler
    RefExtractor --> FileHandler
    FileHandler --> SplitFiles
    FileHandler --> MkDocsConfig
    LinkValidator --> ValidationReport
    ErrorHandler --> Logger
    FileHandler --> FilenameSanitizer
    MkDocsGen --> MkDocsConfig

    %% Testing Relationships
    CoreTests -.-> MarkdownEngine
    CLITests -.-> CLI
    TestData -.-> CoreTests

    %% Click Events
    click CLI "https://github.com/eli64s/splitme-ai/blob/main/src/splitme_ai/cli.py"
    click MarkdownEngine "https://github.com/eli64s/splitme-ai/blob/main/src/splitme_ai/core.py"
    click ConfigManager "https://github.com/eli64s/splitme-ai/blob/main/src/splitme_ai/config.py"
    click ErrorHandler "https://github.com/eli64s/splitme-ai/blob/main/src/splitme_ai/errors.py"
    click LinkConverter "https://github.com/eli64s/splitme-ai/blob/main/src/splitme_ai/tools/markdown_link_converter.py"
    click LinkValidator "https://github.com/eli64s/splitme-ai/blob/main/src/splitme_ai/tools/markdown_link_validator.py"
    click RefExtractor "https://github.com/eli64s/splitme-ai/blob/main/src/splitme_ai/tools/reference_link_extractor.py"
    click MkDocsGen "https://github.com/eli64s/splitme-ai/blob/main/src/splitme_ai/generators/mkdocs_config.py"
    click FileHandler "https://github.com/eli64s/splitme-ai/blob/main/src/splitme_ai/utils/file_handler.py"
    click FilenameSanitizer "https://github.com/eli64s/splitme-ai/blob/main/src/splitme_ai/utils/filename_sanitizer.py"
    click Logger "https://github.com/eli64s/splitme-ai/blob/main/src/splitme_ai/logger.py"
    click CoreTests "https://github.com/eli64s/splitme-ai/blob/main/tests/splitme_ai/test_core.py"
    click CLITests "https://github.com/eli64s/splitme-ai/blob/main/tests/splitme_ai/test_cli.py"
    click TestData "https://github.com/eli64s/splitme-ai/tree/main/tests/data/"

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Tools"]:::tools
        L3["Utilities"]:::utils
        L4["Input/Output"]:::input
        L5["Generators"]:::generator
        L6["Testing"]:::testing
    end
```
