# ivanbrasilico/virasana architecture

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

- Interactive diagram: https://gitdiagram.com/ivanbrasilico/virasana
- Repository: https://github.com/ivanbrasilico/virasana

## Overview

##### Main Components

a. Web Application Layer
- Flask-based web server (evidenced by templates/, routes/, and wsgi files)
- Authentication system (login templates and account management)
- Web interface for image viewing and interaction

b. Integration Layer
- Multiple data source integrations under virasana/integracao/
- Bagagens (luggage processing)
- Carga (cargo processing)
- DUE (customs declarations)
- Mercante (merchant marine data)
- PADMA (integration with external system)

c. Data Processing Layer
- Analysis modules (virasana/analises/)
- Export functionality (virasana/exportacao/)
- Image processing and search capabilities (virasana/models/image_search.py)

d. Worker System
- Celery-based task processing (evidenced by celery.sh and workers/)
- Periodic tasks execution
- Directory monitoring system

e. Storage Layer
- MongoDB integration (evidenced by GridFS usage in tests)
- File storage system for images
- Text indexing capabilities

##### Relationships to Highlight

- External systems → Integration Layer → Storage Layer
- Web Application ↔ Storage Layer
- Workers → Storage Layer
- Integration Layer → Workers (for async processing)

##### Architectural Patterns to Emphasize

- Microservices-like architecture with distinct components
- Event-driven processing (workers and periodic tasks)
- MVC pattern in web application (models, views, routes)
- ETL patterns for data integration

**[External Systems] → [Integration Layer] → [Processing Layer]**
- ↑               ↑                        ↑

- ↓               ↓                        ↓
**[Web Application] ←→ [Storage Layer] ←→ [Worker System]**

##### Important Technical Elements

- Flask (Web Framework)
- Celery (Task Queue)
- MongoDB (Database)
- GridFS (File Storage)
- API endpoints (evidenced by routes/)
- Authentication system
- Monitoring and logging systems

##### Detailed component interaction

Remember to:
- Keep components loosely coupled
- Clear boundaries between systems
- Scalability points
- Critical paths and dependencies
- Monitoring and logging flows
- Integration points with external systems

This system appears to be a complex image processing and management system with multiple integration points, so emphasis should be placed on showing clear boundaries between components while maintaining visibility of the entire system's workflow.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph External["External Systems"]
        PADMA["PADMA System"]
        Bagagens["Baggage Systems"]
        Mercante["Merchant Marine"]
        DUE["Customs Declarations"]
    end

    subgraph WebApp["Web Application Layer"]
        Flask["Flask Server"]:::web
        Routes["Routes"]:::web
        Templates["Templates"]:::web
        Static["Static Files"]:::web
        WSGI["WSGI Entry"]:::web
    end

    subgraph Integration["Integration Layer"]
        IntBase["Integration Base"]:::integration
        BagInt["Baggage Integration"]:::integration
        CargoInt["Cargo Integration"]:::integration
        DUEInt["DUE Integration"]:::integration
        MercanteInt["Mercante Integration"]:::integration
        PADMAInt["PADMA Integration"]:::integration
    end

    subgraph Processing["Data Processing Layer"]
        Analysis["Analysis Module"]:::processing
        Export["Export Functions"]:::processing
        ImageSearch["Image Search"]:::processing
        TextIndex["Text Indexing"]:::processing
    end

    subgraph Workers["Worker System"]
        Tasks["Worker Tasks"]:::worker
        PeriodicTasks["Periodic Tasks"]:::worker
        DirMonitor["Directory Monitor"]:::worker
        CeleryConfig["Celery Config"]:::worker
    end

    subgraph Storage["Storage Layer"]
        MongoDB[(MongoDB)]:::storage
        GridFS[(GridFS)]:::storage
        DBConfig["Database Config"]:::storage
        DataModels["Data Models"]:::storage
        AuditModels["Audit Models"]:::storage
    end

    subgraph UseCases["Business Logic Layer"]
        APIManager["API Management"]:::logic
        BagManager["Baggage Management"]:::logic
        AuditLogic["Audit Logic"]:::logic
    end

    %% External to Integration
    PADMA --> PADMAInt
    Bagagens --> BagInt
    Mercante --> MercanteInt
    DUE --> DUEInt

    %% Integration to Processing
    IntBase --> Analysis
    BagInt --> Analysis
    CargoInt --> Analysis
    DUEInt --> Analysis
    MercanteInt --> Analysis

    %% Processing to Storage
    Analysis --> MongoDB
    ImageSearch --> GridFS
    TextIndex --> MongoDB

    %% Web App Flow
    Flask --> Routes
    Routes --> Templates
    Routes --> Static
    WSGI --> Flask

    %% Worker System
    Tasks --> MongoDB
    PeriodicTasks --> MongoDB
    DirMonitor --> GridFS

    %% Business Logic
    APIManager --> MongoDB
    BagManager --> MongoDB
    AuditLogic --> AuditModels

    %% Storage Relationships
    DBConfig --> MongoDB
    DataModels --> MongoDB
    AuditModels --> MongoDB

    %% Click Events
    click Flask "https://github.com/IvanBrasilico/virasana/blob/master/virasana/main.py"
    click Routes "https://github.com/IvanBrasilico/virasana/tree/master/virasana/routes/"
    click Templates "https://github.com/IvanBrasilico/virasana/tree/master/virasana/templates/"
    click Static "https://github.com/IvanBrasilico/virasana/tree/master/virasana/static/"
    click WSGI "https://github.com/IvanBrasilico/virasana/blob/master/wsgi.py"
    click IntBase "https://github.com/IvanBrasilico/virasana/tree/master/virasana/integracao/"
    click BagInt "https://github.com/IvanBrasilico/virasana/tree/master/virasana/integracao/bagagens/"
    click CargoInt "https://github.com/IvanBrasilico/virasana/tree/master/virasana/integracao/carga2/"
    click DUEInt "https://github.com/IvanBrasilico/virasana/tree/master/virasana/integracao/due/"
    click MercanteInt "https://github.com/IvanBrasilico/virasana/tree/master/virasana/integracao/mercante/"
    click PADMAInt "https://github.com/IvanBrasilico/virasana/blob/master/virasana/integracao/padma.py"
    click Analysis "https://github.com/IvanBrasilico/virasana/tree/master/virasana/analises/"
    click Export "https://github.com/IvanBrasilico/virasana/tree/master/virasana/exportacao/"
    click ImageSearch "https://github.com/IvanBrasilico/virasana/blob/master/virasana/models/image_search.py"
    click TextIndex "https://github.com/IvanBrasilico/virasana/blob/master/virasana/models/text_index.py"
    click Tasks "https://github.com/IvanBrasilico/virasana/blob/master/virasana/workers/tasks.py"
    click PeriodicTasks "https://github.com/IvanBrasilico/virasana/blob/master/virasana/workers/periodic_tasks.py"
    click DirMonitor "https://github.com/IvanBrasilico/virasana/blob/master/virasana/workers/dir_monitor.py"
    click CeleryConfig "https://github.com/IvanBrasilico/virasana/blob/master/celery.sh"
    click DBConfig "https://github.com/IvanBrasilico/virasana/blob/master/virasana/db.py"
    click DataModels "https://github.com/IvanBrasilico/virasana/blob/master/virasana/models/models.py"
    click AuditModels "https://github.com/IvanBrasilico/virasana/blob/master/virasana/models/auditoria.py"
    click APIManager "https://github.com/IvanBrasilico/virasana/blob/master/virasana/usecases/apirecintos_manager.py"
    click BagManager "https://github.com/IvanBrasilico/virasana/blob/master/virasana/usecases/bagagens_manager.py"
    click AuditLogic "https://github.com/IvanBrasilico/virasana/blob/master/virasana/usecases/auditoria.py"

    classDef web fill:#2196F3,stroke:#1565C0,color:white
    classDef integration fill:#4CAF50,stroke:#2E7D32,color:white
    classDef processing fill:#FFC107,stroke:#FFA000,color:black
    classDef worker fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef storage fill:#F44336,stroke:#C62828,color:white
    classDef logic fill:#795548,stroke:#4E342E,color:white
```
