# 6tail/tyme4go architecture

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

- Interactive diagram: https://gitdiagram.com/6tail/tyme4go
- Repository: https://github.com/6tail/tyme4go

## Overview

##### Project type and purpose
- This is a Go-based, open-source calendar “toolkit” library (not a web app or microservice).
- It provides a rich API for working with multiple calendrical systems (solar, lunar, Tibetan), zodiac, astrology, festivals, holidays, etc.

##### File structure
- Top-level:
- go.mod (module declaration)
- README.md, LICENSE, CHANGELOG.md
- /test (unit tests for every calendar concept)
- /tyme (all Go source code)
- /tyme organizes code by domain concept: each file is one calendar entity (e.g. SolarDay.go, LunarMonth.go), plus interfaces and provider implementations (e.g. IChildLimitProvider.go, China95ChildLimitProvider.go).
- No frontend, no database, no external server—pure library code.

##### README for additional insights
- Confirms it’s a library (“calendar tool library”), upgraded from a predecessor.
- Mentions Go 1.19 target.
- Relies on third-party datasets/algorithms (sxwnl for solar terms, zangli for Tibetan calendar).

##### Detail without overthinking
- Every major directory and package boundary
- Interface and at least one concrete implementation
- Overall flow: Client → API → Domain → Interfaces → Implementations → External Data

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    Client["Client Application"]:::external

    %% Public API Layer
    PublicAPI["Tyme Entry Point (Tyme.go)"]:::api
    click PublicAPI "https://github.com/6tail/tyme4go/blob/master/tyme/Tyme.go"

    %% Core Domain Modules
    subgraph "Core Domain Modules"
        direction TB
        SolarDay["SolarDay Module"]:::core
        click SolarDay "https://github.com/6tail/tyme4go/blob/master/tyme/SolarDay.go"
        LunarDay["LunarDay Module"]:::core
        click LunarDay "https://github.com/6tail/tyme4go/blob/master/tyme/LunarDay.go"
        Zodiac["Zodiac Module"]:::core
        click Zodiac "https://github.com/6tail/tyme4go/blob/master/tyme/Zodiac.go"
    end

    %% Provider Interfaces
    subgraph "Provider Interfaces"
        direction TB
        IChildLimit["IChildLimitProvider"]:::interface
        click IChildLimit "https://github.com/6tail/tyme4go/blob/master/tyme/IChildLimitProvider.go"
        IEightChar["IEightCharProvider"]:::interface
        click IEightChar "https://github.com/6tail/tyme4go/blob/master/tyme/IEightCharProvider.go"
    end

    %% Provider Implementations
    subgraph "Provider Implementations"
        direction TB
        DefaultEightChar["DefaultEightCharProvider"]:::provider
        click DefaultEightChar "https://github.com/6tail/tyme4go/blob/master/tyme/DefaultEightCharProvider.go"
        DefaultChildLimit["DefaultChildLimitProvider"]:::provider
        click DefaultChildLimit "https://github.com/6tail/tyme4go/blob/master/tyme/DefaultChildLimitProvider.go"
        China95Child["China95ChildLimitProvider"]:::provider
        click China95Child "https://github.com/6tail/tyme4go/blob/master/tyme/China95ChildLimitProvider.go"
        LunarSect1Child["LunarSect1ChildLimitProvider"]:::provider
        click LunarSect1Child "https://github.com/6tail/tyme4go/blob/master/tyme/LunarSect1ChildLimitProvider.go"
        LunarSect2Child["LunarSect2ChildLimitProvider"]:::provider
        click LunarSect2Child "https://github.com/6tail/tyme4go/blob/master/tyme/LunarSect2ChildLimitProvider.go"
        LunarSect2EightChar["LunarSect2EightCharProvider"]:::provider
        click LunarSect2EightChar "https://github.com/6tail/tyme4go/blob/master/tyme/LunarSect2EightCharProvider.go"
    end

    %% External Algorithms/Data Sources
    subgraph "External Data/Algorithms"
        direction TB
        SXWNL["sxwnl (Solar Terms)"]:::external
        ZANGLI["zangli (Tibetan Calendar)"]:::external
    end

    %% Test Suite
    subgraph "Test Suite" 
        direction TB
        style TestSuite stroke-dasharray: 5 5
        TestSuite["Unit Tests (test/)"]:::test
        click TestSuite "https://github.com/6tail/tyme4go/tree/master/test/"
    end

    %% Relationships
    Client -->|"imports"| PublicAPI
    PublicAPI -->|"uses"| SolarDay
    PublicAPI -->|"uses"| LunarDay
    PublicAPI -->|"uses"| Zodiac

    SolarDay -->|"may use"| IChildLimit
    LunarDay -->|"may use"| IEightChar
    Zodiac -->|"may use"| IEightChar

    IChildLimit -->|"implemented by"| DefaultChildLimit
    IChildLimit -->|"implemented by"| China95Child
    IChildLimit -->|"implemented by"| LunarSect1Child
    IChildLimit -->|"implemented by"| LunarSect2Child

    IEightChar -->|"implemented by"| DefaultEightChar
    IEightChar -->|"implemented by"| LunarSect2EightChar

    DefaultEightChar -->|"internal logic"| SyntheticEngine
    LunarSect2EightChar -->|"delegates to"| ZANGLI

    DefaultChildLimit -->|"internal logic"| SyntheticEngine
    China95Child -->|"delegates to"| SXWNL
    LunarSect1Child -->|"internal logic"| SyntheticEngine
    LunarSect2Child -->|"internal logic"| SyntheticEngine

    PublicAPI --> TestSuite
    SolarDay --> TestSuite
    LunarDay --> TestSuite
    Zodiac --> TestSuite
    IChildLimit --> TestSuite
    IEightChar --> TestSuite
    DefaultChildLimit --> TestSuite
    DefaultEightChar --> TestSuite
    China95Child --> TestSuite
    LunarSect1Child --> TestSuite
    LunarSect2Child --> TestSuite
    LunarSect2EightChar --> TestSuite

    %% Styles
    classDef core fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef provider fill:#90EE90,stroke:#000,stroke-width:1px
    classDef interface fill:#FFFF66,stroke:#000,stroke-width:1px,shape:hexagon
    classDef api fill:#87CEFA,stroke:#000,stroke-width:1px
    classDef external fill:#F0F0F0,stroke:#000,stroke-width:1px
    classDef test fill:none,stroke:#000,stroke-dasharray: 5 5,stroke-width:1px
```
