# grycap/onetrigger architecture

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

- Interactive diagram: https://gitdiagram.com/grycap/onetrigger
- Repository: https://github.com/grycap/onetrigger

## Overview

##### Main components
- OneTrigger CLI (entry point)
- Configuration Parser
- OneProviderClient (client to Oneprovider API/event stream)
- Event Processor (builds JSON payload)
- Webhook Sender (HTTP POST to user’s endpoint)
- External Systems:
– Oneprovider (Onedata file‐event provider)
– Webhook Receiver (user’s HTTP endpoint)
- Packaging/Deployment:
– Docker container / Kubernetes deployment

##### Relationships and data flows
- User invokes `onetrigger run` (CLI)
↓
- CLI module reads arguments & env vars via Config Parser
↓
- OneProviderClient establishes connection (REST or SSE) to Oneprovider
↓
- Onedata file events stream back into OneTrigger
↓
- Event Processor constructs the JSON payload
↓
- Webhook Sender issues HTTP POST to the configured webhook URL

##### Architectural patterns and design principles
- Separation of concerns:
– configparser.py handles only configuration
– oneproviderclient.py abstracts API communication
– onetrigger.py orchestrates modules and CLI interface
- Dependency inversion: modules depend on abstractions (e.g., pass a session object into the client)
- Single responsibility: each component has one clearly defined role

##### Call out key technologies and frameworks
- Python 3
- requests or aiohttp (HTTP client in oneproviderclient.py and webhook sender)
- click or argparse (CLI parsing in onetrigger.py)
- Dockerfile (container image)
- Kubernetes YAML (optional deployment)
- PyPI packaging (`setup.py`)

##### Detailed component breakdown (to include
– Entry Point: onetrigger/onetrigger.py (CLI)
– Config: onetrigger/configparser.py (env vars & args)
– Client Library: onetrigger/oneproviderclient.py
– Core Logic: onetrigger/onetrigger.py (subscribe loop + dispatch)
– Payload Builder: inline in onetrigger.py or separate utility
– Sender: uses requests.post to WEBHOOK URL
– Packaging: setup.py → PyPI, Dockerfile → grycap/onetrigger
– Deployment: Kubernetes YAML snippet

- Captures all essential modules and their interactions
- Clearly shows external integrations and protocols
- Highlights packaging and deployment options
- Uses consistent notation for easy comprehension
- Is tailored to OneTrigger’s role as an event-forwarding CLI/microservice

This approach ensures maximum clarity for developers and operators alike, while accurately reflecting OneTrigger’s architecture and design principles.

## Diagram (Mermaid)

```mermaid
graph TB
    %% External Systems
    OP[(Oneprovider)]:::external
    WR["Webhook Receiver"]:::external

    %% OneTrigger Core Modules
    subgraph "OneTrigger Core"
        direction TB
        CLI["OneTrigger CLI\n(onetrigger/onetrigger.py)"]:::internal
        Config["Config Parser\n(onetrigger/configparser.py)"]:::internal
        OPC["OneProviderClient\n(onetrigger/oneproviderclient.py)"]:::internal
        EP["Event Processor\n(internal functions in onetrigger.py)"]:::internal
        WS["Webhook Sender\n(internal functions in onetrigger.py)"]:::internal
        VM["Version Metadata\n(onetrigger/version.py)"]:::internal
    end

    %% Packaging & Deployment
    subgraph "Packaging & Deployment"
        direction TB
        PKG["PyPI Packaging\n(setup.py)"]:::deployment
        REQ["Dependencies\n(requirements.txt)"]:::deployment
        DB["Docker Build\n(Dockerfile)"]:::deployment
        CI["CI & Metadata\n(.travis.yml,\nREADME.md,\nLICENSE)"]:::deployment
        K8S["Kubernetes Deployment"]:::deployment
    end

    %% Flows
    User["User"]:::external -->|"runs `onetrigger run`"| CLI
    CLI -->|"reads args/env"| Config
    Config -->|"inject config"| OPC
    OPC -->|"REST/SSE"| OP
    OP -->|"file events"| OPC
    OPC -->|"event stream"| EP
    EP -->|"builds JSON"| WS
    WS -->|"HTTP POST"| WR

    %% Packaging flows
    CLI --> PKG
    PKG --> REQ
    REQ --> DB
    DB --> K8S
    CI --> DB

    %% Click Events
    click CLI "https://github.com/grycap/onetrigger/blob/master/onetrigger/onetrigger.py"
    click Config "https://github.com/grycap/onetrigger/blob/master/onetrigger/configparser.py"
    click OPC "https://github.com/grycap/onetrigger/blob/master/onetrigger/oneproviderclient.py"
    click EP "https://github.com/grycap/onetrigger/blob/master/onetrigger/onetrigger.py"
    click WS "https://github.com/grycap/onetrigger/blob/master/onetrigger/onetrigger.py"
    click VM "https://github.com/grycap/onetrigger/blob/master/onetrigger/version.py"
    click PKG "https://github.com/grycap/onetrigger/blob/master/setup.py"
    click REQ "https://github.com/grycap/onetrigger/blob/master/requirements.txt"
    click DB "https://github.com/grycap/onetrigger/tree/master/Dockerfile"
    click CI "https://github.com/grycap/onetrigger/blob/master/.travis.yml"
    click CI "https://github.com/grycap/onetrigger/blob/master/README.md"
    click CI "https://github.com/grycap/onetrigger/tree/master/LICENSE"

    %% Styles
    classDef internal fill:#D0E8FF,stroke:#0366D6,color:#000;
    classDef external fill:#E2F0D9,stroke:#2C662D,color:#000;
    classDef deployment fill:#F2F2F2,stroke:#7D7D7D,color:#000;
```
