# rapidataai/rapidata-python-sdk architecture

> Architecture diagram of the GitHub repository rapidataai/rapidata-python-sdk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rapidataai/rapidata-python-sdk
- Repository: https://github.com/rapidataai/rapidata-python-sdk

## Overview

##### Main Components

a. Client Layer:
- Key client components: OrderManager, ValidationSetManager, and RapidsManager

b. Core Domain Objects:
- Orders (RapidataOrder, OrderBuilder)
- Workflows (ClassifyWorkflow, CompareWorkflow, etc.)
- Assets (MediaAsset, TextAsset, MultiAsset)
- Selections (ValidationSelection, DemographicSelection, etc.)
- Metadata handling components

c. Service Layer:
- CredentialManager
- TokenManager
- OpenAPIService
- LocalFileService

d. API Client Layer:
- Generated API clients (from OpenAPI specs)
- API models and endpoints
- REST communication handling

##### Relationships and Interactions

- Client → Service Layer (dependency)
- Client → Core Domain Objects (composition)
- Service Layer → API Client Layer (uses)
- Core Domain Objects → API Models (transforms)

##### Component Details

For each major component, include:
- Component name
- Key responsibilities
- Major public interfaces
- Dependencies

##### Specific Implementation Details

Specialized sections for:
- Authentication flow
- Order creation pipeline
- Validation handling
- Asset management

**┌─────────────────────────────────────────────────────┐**
- Client Interface                    │
- (RapidataClient, OrderManager, ValidationManager)  │
- ┤
- Domain Objects                      │
- (Orders, Workflows, Assets, Selections, Metadata)   │
- ┤
- Service Layer                       │
- (Credential, Token, OpenAPI, File Services)        │
- ┤
- API Client Layer                    │
- (Generated Clients, Models, REST Communication)    │
- ┤
- External API                        │
- (Rapidata API Service)                 │
- ┘

##### Technical Details to Highlight

- OpenAPI generation workflow
- Authentication mechanisms
- File handling capabilities
- Validation patterns
- Order lifecycle management

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef client fill:#b3d1ff,stroke:#333,stroke-width:2px
    classDef domain fill:#ffffb3,stroke:#333,stroke-width:2px
    classDef service fill:#b3ffb3,stroke:#333,stroke-width:2px
    classDef api fill:#ffcc99,stroke:#333,stroke-width:2px
    classDef external fill:#e6e6e6,stroke:#333,stroke-width:2px

    %% Client Layer
    subgraph ClientLayer["Client Interface Layer"]
        RC["RapidataClient"]:::client
        OM["OrderManager"]:::client
        VM["ValidationSetManager"]:::client
        RM["RapidsManager"]:::client
    end

    %% Domain Objects Layer
    subgraph DomainLayer["Domain Objects Layer"]
        Orders["Orders"]:::domain
        Workflows["Workflows"]:::domain
        Assets["Assets"]:::domain
        Selections["Selections"]:::domain
        Metadata["Metadata"]:::domain
    end

    %% Service Layer
    subgraph ServiceLayer["Service Layer"]
        CM["CredentialManager"]:::service
        TM["TokenManager"]:::service
        OS["OpenAPIService"]:::service
        FS["LocalFileService"]:::service
    end

    %% API Client Layer
    subgraph APILayer["API Client Layer"]
        AC["Generated API Clients"]:::api
        AM["API Models"]:::api
        REST["REST Communication"]:::api
    end

    %% External System
    EA["Rapidata API Service"]:::external

    %% Relationships
    RC --> OM
    RC --> VM
    RC --> RM
    
    OM --> Orders
    VM --> Selections
    RM --> Workflows
    
    Orders --> Assets
    Orders --> Metadata
    
    CM --> TM
    TM --> OS
    OS --> FS
    
    ServiceLayer --> APILayer
    APILayer --> EA
    
    DomainLayer --> AM

    %% Click Events
    click RC "https://github.com/RapidataAI/rapidata-python-sdk/blob/main/src/rapidata/rapidata_client/rapidata_client.py"
    click OM "https://github.com/RapidataAI/rapidata-python-sdk/blob/main/src/rapidata/rapidata_client/order/rapidata_order_manager.py"
    click VM "https://github.com/RapidataAI/rapidata-python-sdk/blob/main/src/rapidata/rapidata_client/validation/validation_set_manager.py"
    click RM "https://github.com/RapidataAI/rapidata-python-sdk/blob/main/src/rapidata/rapidata_client/validation/rapids/rapids_manager.py"
    
    click Orders "https://github.com/RapidataAI/rapidata-python-sdk/tree/main/src/rapidata/rapidata_client/order/"
    click Workflows "https://github.com/RapidataAI/rapidata-python-sdk/tree/main/src/rapidata/rapidata_client/workflow/"
    click Assets "https://github.com/RapidataAI/rapidata-python-sdk/tree/main/src/rapidata/rapidata_client/assets/"
    click Selections "https://github.com/RapidataAI/rapidata-python-sdk/tree/main/src/rapidata/rapidata_client/selection/"
    click Metadata "https://github.com/RapidataAI/rapidata-python-sdk/tree/main/src/rapidata/rapidata_client/metadata/"
    
    click CM "https://github.com/RapidataAI/rapidata-python-sdk/blob/main/src/rapidata/service/credential_manager.py"
    click TM "https://github.com/RapidataAI/rapidata-python-sdk/blob/main/src/rapidata/service/token_manager.py"
    click OS "https://github.com/RapidataAI/rapidata-python-sdk/blob/main/src/rapidata/service/openapi_service.py"
    click FS "https://github.com/RapidataAI/rapidata-python-sdk/blob/main/src/rapidata/service/local_file_service.py"
    
    click AC "https://github.com/RapidataAI/rapidata-python-sdk/tree/main/src/rapidata/api_client/api/"
    click AM "https://github.com/RapidataAI/rapidata-python-sdk/tree/main/src/rapidata/api_client/models/"
    click REST "https://github.com/RapidataAI/rapidata-python-sdk/blob/main/src/rapidata/api_client/rest.py"

    %% Legend
    subgraph Legend
        C1["Client Components"]:::client
        D1["Domain Objects"]:::domain
        S1["Services"]:::service
        A1["API Components"]:::api
        E1["External Systems"]:::external
    end
```
