# sqlizer-io/sqlizer-client-py architecture

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

- Interactive diagram: https://gitdiagram.com/sqlizer-io/sqlizer-client-py
- Repository: https://github.com/sqlizer-io/sqlizer-client-py

## Overview

##### Project Type Analysis
This is a Python API client library that serves as a wrapper for the SQLizer.io file conversion service. It's designed to convert various file formats (CSV, JSON, Excel, XML) into SQL tables.

##### Main Components

A. Client Library Components:
- Core Client Module (sqlizer.File)
- Configuration Handler (config.py)
- Type Definitions:
- DatabaseType Enums
- FileType Enums
- API URL Management (apiurls.py)
- Conversion Status Handling (conversionstatus.py)

B. External Components:
- SQLizer.io API Service
- File Storage Systems (Input/Output)

**Components Representation:**
**┌─────────────────────────────────────────────────────────────┐**
- Python Application                          │
- ┌─────────────────┐        ┌────────────────────┐        │
- Client Code    │        │   SQLizer Library  │        │
- ┘        └────────────────────┘        │
- ┘

**Use these symbols:**
- Rectangles: For main components
- Rounded rectangles: For modules/classes

##### Specific Component Details

a) Input Layer (Blue):
- File Input Handlers (CSV, JSON, Excel, XML)
- Configuration Management (API Key)

b) Core Processing Layer (Green):
- File Class (Main interface)
- Type Enums (DatabaseType, FileType)
- Conversion Status Management

c) API Communication Layer (Orange):
- API URL Management
- HTTP Client Handling
- Response Processing

d) External Services Layer (Gray):
- SQLizer.io API Service
- File Storage Systems

##### Data Flow Representation

**Input File → File Class → API Client → SQLizer.io API → SQL Output**

##### Important Elements to Highlight

- Configuration Management:
- API Key handling
- Environment settings

- Type System:
- Supported file types
- Database type options

- Error Handling Flow:
- Status checking
- Error propagation

##### Implementation Details

**┌─────────────────────────────────────────────────────────┐**
- SQLizer Client Library                  │

- ┌─────────────┐    ┌──────────────┐    ┌──────────┐   │
- Config    │    │  File Class  │    │   API    │   │
- Manager    │───▶│   Handler    │───▶│  Client  │   │
- ┘    └──────────────┘    └────────┬─┘   │
- ▲                   ▲                     │      │
- ┌──────────────┐            │      │
- Type Enums  │            │      │
- ┘            ▼      │
- ┌────────┐                            ┌────────────┐ │
- API Key │                            │SQLizer.io  │ │
- ┘                            │   API      │ │
- ┘

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client_Application
        UserCode["Client Code"]
    end

    subgraph SQLizer_Library["SQLizer Python Client Library"]
        Config["Configuration Manager"]:::config
        FileClass["File Class"]:::file
        TypeSystem["Type System"]
        APIClient["API Client"]:::api
        ConvStatus["Conversion Status"]:::status
        PropNames["Property Names"]:::props

        subgraph Type_Definitions
            DBType["Database Types"]:::dbtype
            FType["File Types"]:::ftype
        end

        subgraph API_Layer
            APIUrls["API URLs"]:::apiurls
            HTTPClient["HTTP Client"]
        end
    end

    subgraph External_Services
        SQLizerAPI["SQLizer.io API"]
        Storage["File Storage Systems"]
    end

    subgraph Testing
        TestSuite["Test Suite"]:::test
        TestData["Test Data Files"]:::testdata
    end

    %% Relationships
    UserCode --> FileClass
    FileClass --> Config
    FileClass --> TypeSystem
    FileClass --> APIClient
    TypeSystem --> DBType
    TypeSystem --> FType
    APIClient --> APIUrls
    APIClient --> HTTPClient
    APIClient --> ConvStatus
    APIClient --> PropNames
    HTTPClient --> SQLizerAPI
    SQLizerAPI --> Storage

    %% Click Events
    click Config "https://github.com/sqlizer-io/sqlizer-client-py/blob/main/src/sqlizer/config.py"
    click FileClass "https://github.com/sqlizer-io/sqlizer-client-py/blob/main/src/sqlizer/file.py"
    click DBType "https://github.com/sqlizer-io/sqlizer-client-py/blob/main/src/sqlizer/databasetype.py"
    click FType "https://github.com/sqlizer-io/sqlizer-client-py/blob/main/src/sqlizer/filetype.py"
    click APIUrls "https://github.com/sqlizer-io/sqlizer-client-py/blob/main/src/sqlizer/apiurls.py"
    click ConvStatus "https://github.com/sqlizer-io/sqlizer-client-py/blob/main/src/sqlizer/conversionstatus.py"
    click PropNames "https://github.com/sqlizer-io/sqlizer-client-py/blob/main/src/sqlizer/propertynames.py"
    click TestSuite "https://github.com/sqlizer-io/sqlizer-client-py/blob/main/src/tests/test_file_conversion.py"
    click TestData "https://github.com/sqlizer-io/sqlizer-client-py/blob/main/src/tests/test.json"

    %% Styles
    classDef config fill:#f9f,stroke:#333
    classDef file fill:#bbf,stroke:#333
    classDef api fill:#fb7,stroke:#333
    classDef status fill:#bfb,stroke:#333
    classDef props fill:#fbb,stroke:#333
    classDef dbtype fill:#ddf,stroke:#333
    classDef ftype fill:#ddf,stroke:#333
    classDef apiurls fill:#ffd,stroke:#333
    classDef test fill:#ddd,stroke:#333
    classDef testdata fill:#ddd,stroke:#333

    %% Legend
    subgraph Legend
        L1["Configuration Components"]:::config
        L2["Core Components"]:::file
        L3["API Components"]:::api
        L4["Status Handling"]:::status
        L5["Property Management"]:::props
        L6["Type Definitions"]:::dbtype
        L7["Testing Components"]:::test
    end
```
