# darkyamagai/pymino architecture

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

- Interactive diagram: https://gitdiagram.com/darkyamagai/pymino
- Repository: https://github.com/darkyamagai/pymino

## Overview

##### Project type and purpose
- This is an open-source Python library (“pymino”) that wraps the Amino Apps HTTP/WebSocket API.
- It exposes two main entry points:
- Client – a low-level API client for HTTP calls and community operations.
- Bot – a higher-level, event-driven framework with commands, tasks, and event listeners.

##### File structure
- Top-level package “pymino/”:
- bot.py – defines the Bot class, event decorators, command/task registration, and run loop.
- client.py – defines the Client class, login, community management, and raw API calls.
- “pymino/ext/” – extension modules and core sub-components:
- account.py, community.py, console.py, context.py – provide layered APIs and context objects.
- dispatcher.py – event dispatching and listener registry (observer pattern).
- global_client.py, handle_queue.py – shared network client and async event queue.
- socket.py – WebSocket connection handler for real-time events.
- “pymino/ext/entities/” – data models reflecting API responses (Messages, Threads, Users, etc.).
- “pymino/ext/utilities/” – helpers for request handling, console UIs, command parsing, code generation.
- Configuration/build files: setup.py, pyproject.toml, requirements.txt.

##### Insights from README
- The library uses both HTTP (Client) and WebSocket (Bot) to communicate with Amino Apps.
- Bot features include event callbacks (@bot.on_text_message, @bot.command, @bot.task), and an optional console.
- Entities are passed into user callbacks (Context, Member, Message, etc.).
- It supports proxies and custom device IDs.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User Code
    subgraph "User Code"
        U["User Script\n(import Client/Bot)"]:::user
    end

    %% Core Network Components
    subgraph "Core Network Layer"
        direction TB
        C["Client"]:::core
        B["Bot"]:::core
        S["WebSocket Handler"]:::core
    end

    %% Shared Components
    subgraph "Shared Core"
        direction TB
        GC["Global Client"]:::core
        EQ["Event Queue"]:::core
        D["Dispatcher"]:::core
    end

    %% Extension Modules
    subgraph "Extension Modules"
        direction TB
        AExt["Account"]:::ext
        CExt["Community"]:::ext
        ConExt["Console"]:::ext
        Contx["Context"]:::ext
    end

    %% Utilities
    subgraph "Utilities"
        direction TB
        UTIL["Utilities"]:::utilities
        CP["Command Parser"]:::utilities
        RH["Request Handler"]:::utilities
    end

    %% Data Models
    subgraph "Entities"
        direction TB
        E["Entities"]:::entities
    end

    %% External Service
    subgraph "External API"
        direction TB
        AminoHTTP["Amino HTTP API"]:::external
        AminoWS["Amino WS Endpoint"]:::external
    end

    %% Build & Config
    subgraph "Build & Config"
        direction TB
        S1["setup.py"]:::config
        S2["pyproject.toml"]:::config
        S3["requirements.txt"]:::config
    end

    %% Connections
    U -->|"uses"| C
    U -->|"uses"| B

    C -->|"HTTP calls"| AminoHTTP
    B -->|"connects"| AminoWS
    AminoWS -->|"events"| EQ
    GC -->|"shared client"| C
    GC -->|"shared client"| S

    EQ -->|"queues events"| D
    D -->|"dispatches"| B
    D -->|"dispatches"| ConExt
    D -->|"dispatches"| AExt
    D -->|"dispatches"| CExt

    B -->|"decorators & tasks"| D
    D -->|"provides Context"| Contx

    CExt -->|"uses Client"| C
    AExt -->|"uses Client"| C
    ConExt -->|"uses Context"| Contx

    C -->|"parses payloads"| E
    S -->|"parses payloads"| E
    D -->|"uses Entities"| E

    B -->|"command flow"| CP
    CP -->|"invokes"| D
    UTIL -->|"provides helpers"| C
    UTIL -->|"provides helpers"| B
    RH -->|"handles requests"| C

    %% Click Events
    click C "https://github.com/darkyamagai/pymino/blob/main/pymino/client.py"
    click B "https://github.com/darkyamagai/pymino/blob/main/pymino/bot.py"
    click AExt "https://github.com/darkyamagai/pymino/blob/main/pymino/ext/account.py"
    click CExt "https://github.com/darkyamagai/pymino/blob/main/pymino/ext/community.py"
    click ConExt "https://github.com/darkyamagai/pymino/blob/main/pymino/ext/console.py"
    click Contx "https://github.com/darkyamagai/pymino/blob/main/pymino/ext/context.py"
    click D "https://github.com/darkyamagai/pymino/blob/main/pymino/ext/dispatcher.py"
    click GC "https://github.com/darkyamagai/pymino/blob/main/pymino/ext/global_client.py"
    click EQ "https://github.com/darkyamagai/pymino/blob/main/pymino/ext/handle_queue.py"
    click S "https://github.com/darkyamagai/pymino/blob/main/pymino/ext/socket.py"
    click E "https://github.com/darkyamagai/pymino/tree/main/pymino/ext/entities/"
    click UTIL "https://github.com/darkyamagai/pymino/tree/main/pymino/ext/utilities/"
    click CP "https://github.com/darkyamagai/pymino/blob/main/pymino/ext/utilities/commands.py"
    click RH "https://github.com/darkyamagai/pymino/blob/main/pymino/ext/utilities/request_handler.py"

    %% Styles
    classDef core fill:#DDEBF7,stroke:#2F75B5,color:#2F75B5;
    classDef ext fill:#E2EFDA,stroke:#70AD47,color:#70AD47;
    classDef utilities fill:#FFF2CC,stroke:#BF8F00,color:#BF8F00;
    classDef entities fill:#FCE4D6,stroke:#C55A11,color:#C55A11;
    classDef external fill:#EDEDED,stroke:#A6A6A6,color:#666666;
    classDef config fill:#F2F2F2,stroke:#7F7F7F,color:#4D4D4D;
    classDef user fill:#FFFFFF,stroke:#000000,color:#000000;
```
