# eli64s/dots architecture

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

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

## Overview

##### Main Components Identification

The system should be represented with these primary components:

a) Configuration Management Layer
- Python Configuration Hub
- Git Configuration Hub
- VSCode Configuration Hub
- Zsh Configuration Hub

b) Utility Scripts Layer
- Installation Scripts
- Build Scripts
- File Operation Scripts
- Project Setup Scripts
- Common Utility Scripts

c) Build & Testing Infrastructure
- Make System (Poetry/UV)
- Testing Framework
- Linting & Type Checking

**┌─ Configuration Management Layer ─────────────────────┐**

- ┌─────────┐   ┌────────┐   ┌───────┐   ┌───────┐  │
- Python  │   │  Git   │   │VSCode │   │  Zsh  │  │
- Config  │   │ Config │   │Config │   │Config │  │
- ┘   └────────┘   └───────┘   └───────┘  │
- ▼           ▼           ▼           ▼       │
- ┘

**┌─ Utility Scripts Layer ──────────────────────────────┐**

- ┌─────────┐   ┌────────┐   ┌───────────┐          │
- Install  │   │ Build  │   │   File    │          │
- Scripts  │   │Scripts │   │Operations │          │
- ┘   └────────┘   └───────────┘          │

- ┌─────────┐   ┌────────┐                          │
- Project  │   │Common  │                          │
- Setup    │   │Utils   │                          │
- ┘   └────────┘                          │
- ┘

**┌─ Build & Testing Infrastructure ────────────────────┐**

- ┌─────────┐   ┌────────┐   ┌───────────┐          │
- Make    │   │Testing │   │Linting &  │          │
- Systems  │   │Framework│   │Type Check │          │
- ┘   └────────┘   └───────────┘          │
- ┘

##### Component Relationships

- Configuration files feeding into utility scripts
- Utility scripts interacting with build infrastructure
- Cross-component dependencies

##### Additional Elements

Include:
- Version control integration points
- Shell environment connections
- Testing and linting workflow paths
- Build process flows

##### Specific Implementation Details

- Poetry and UV build system alternatives
- Python testing infrastructure (pytest, behave)
- Shell script categorization (install, builds, file-ops, etc.)
- Configuration file relationships

##### Notes for Implementation

- Keep the abstraction level focused on major components while showing key relationships
- Version control workflow integration
- How shell scripts interact with configuration management
- Demonstrate build and test automation flows

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef config fill:#3498db,stroke:#2980b9,color:white
    classDef utility fill:#2ecc71,stroke:#27ae60,color:white
    classDef infra fill:#e67e22,stroke:#d35400,color:white
    classDef layer fill:none,stroke:#95a5a6,color:black

    %% Configuration Management Layer
    subgraph ConfigLayer["Configuration Management Layer"]
        PythonConfig["Python Config"]:::config
        GitConfig["Git Config"]:::config
        VSCodeConfig["VSCode Config"]:::config
        ZshConfig["Zsh Config"]:::config
    end

    %% Utility Scripts Layer
    subgraph UtilLayer["Utility Scripts Layer"]
        InstallScripts["Installation Scripts"]:::utility
        BuildScripts["Build Scripts"]:::utility
        FileOps["File Operations"]:::utility
        ProjectSetup["Project Setup"]:::utility
        CommonUtils["Common Utils"]:::utility
    end

    %% Build & Testing Infrastructure
    subgraph InfraLayer["Build & Testing Infrastructure"]
        MakeSystems["Make Systems"]:::infra
        TestingFramework["Testing Framework"]:::infra
        LintingType["Linting & Type Check"]:::infra
    end

    %% Relationships
    PythonConfig --> InstallScripts
    GitConfig --> InstallScripts
    VSCodeConfig --> InstallScripts
    ZshConfig --> InstallScripts

    InstallScripts --> MakeSystems
    BuildScripts --> MakeSystems
    FileOps --> TestingFramework
    ProjectSetup --> TestingFramework
    CommonUtils --> LintingType

    %% Click Events
    click PythonConfig "https://github.com/eli64s/dots/tree/main//python/conf/"
    click GitConfig "https://github.com/eli64s/dots/tree/main//git/"
    click VSCodeConfig "https://github.com/eli64s/dots/tree/main//vscode/"
    click ZshConfig "https://github.com/eli64s/dots/tree/main//zsh/"
    click InstallScripts "https://github.com/eli64s/dots/tree/main//scripts/install/"
    click BuildScripts "https://github.com/eli64s/dots/tree/main//scripts/builds/"
    click FileOps "https://github.com/eli64s/dots/tree/main//scripts/file-system/"
    click ProjectSetup "https://github.com/eli64s/dots/tree/main//scripts/cookie-cutter/"
    click CommonUtils "https://github.com/eli64s/dots/tree/main//scripts/common/"
    click MakeSystems "https://github.com/eli64s/dots/tree/main//make/Makefile-poetry"
    click TestingFramework "https://github.com/eli64s/dots/tree/main//python/tests/"
    click LintingType "https://github.com/eli64s/dots/blob/main//python/lint/.ruff.toml"

    %% Legend
    subgraph Legend["Legend"]
        ConfigLegend["Configuration Component"]:::config
        UtilLegend["Utility Script"]:::utility
        InfraLegend["Infrastructure Component"]:::infra
    end
```
