# ignacioe7/proyectodetitulo architecture

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

- Interactive diagram: https://gitdiagram.com/ignacioe7/proyectodetitulo
- Repository: https://github.com/ignacioe7/proyectodetitulo

## Overview

##### Project type and purpose
- This is a full-stack, academic research tool for sentiment analysis on tourism reviews. It combines a data-scraping pipeline, NLP/ML-based sentiment classification, data storage/export, and a Streamlit-based web UI.

##### File structure
- Top-level:
- config.json (region settings)
- data/ (raw and consolidated JSON)
- src/ with subdirectories:
– core/ (scraper.py, analyzer.py, data_handler.py, metrics.py, parsers/)
– models/ (Attraction, Review data classes)
– ui/ (Streamlit app + menu modules)
– utils/ (constants, exporters, logger, networking)
- requirements.txt declares Python, Transformers, PyTorch, Pandas, Plotly, Streamlit, etc.

##### README for architecture clues
- Highlights concurrent processing, export to multiple formats, and interactive visualizations.

##### Main components & interactions (to represent
a. External Data Source
- TripAdvisor (or other review site)
b. Networking Layer
- utils/networking.py handles HTTP requests, rate-limiting, delays
c. Scraper & Parser
- src/core/scraper.py orchestrates page downloads
- src/core/parsers/review_parser.py parses HTML into Review models
d. Data Handler & Models
- src/core/data_handler.py cleans, normalizes, merges data
- src/models/attraction.py & review.py define in-memory objects
- data/consolidated_data.json persists intermediate results
e. Analyzer & Metrics
- src/core/analyzer.py uses Transformers + PyTorch to classify sentiment
- src/core/metrics.py computes statistics (counts, averages, distributions)
f. UI Layer (Streamlit)
- src/ui/streamlit_app.py + menu modules present configuration screens, run buttons, and results views
- Plotly for charts
g. Exporters & Storage
- src/utils/exporters.py writes JSON, CSV, Excel
- data/ directory holds outputs
h. Logging & Config
- src/utils/logger.py captures pipeline events
- config.json and src/utils/constants.py provide parameters

##### Architectural patterns & design principles
- Modular pipeline: clearly separated scraping → parsing → data handling → analysis → visualization/export
- MVC-like separation:
- Model: src/models/**
- Controller/Service: src/core/** + src/utils/**
- View/UI: src/ui/**
- Concurrency: parallel scraping/analysis threads or async I/O
- Single responsibility modules: each component does one job

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "External Layer"
        Ext["TripAdvisor (External Web)"]:::external
    end

    subgraph "Backend Layer"
        networking["Networking Layer\n(utils/networking.py)\nHTTP, rate-limiting"]:::backend
        scraper["Scraper\n(src/core/scraper.py)\nAsync ThreadPool"]:::backend
        parser["Parser\n(src/core/parsers/review_parser.py)"]:::backend
        datahandler["Data Handler\n(src/core/data_handler.py)\nPandas"]:::backend
        analyzer["Analyzer\n(src/core/analyzer.py)\nTransformers/PyTorch"]:::backend
        metrics["Metrics Calculator\n(src/core/metrics.py)\nStatistics"]:::backend
        exporters["Exporters\n(src/utils/exporters.py)\nJSON/CSV/Excel"]:::backend
        logger["Logger\n(src/utils/logger.py)\nPipeline Events"]:::utility
        constants["Config & Constants\n(src/utils/constants.py, config.json)"]:::utility
    end

    subgraph "Data Storage Layer"
        rawdata["Raw/Region Data\n(data/regions/regions.json)"]:::data
        consolidated["Consolidated Data\n(data/consolidated_data.json)"]:::data
    end

    subgraph "UI Layer"
        uiapp["Streamlit App\n(src/ui/streamlit_app.py)\nStreamlit/Plotly"]:::ui
        home["Home Menu\n(src/ui/menu/home.py)"]:::ui
        attractions["Attractions Menu\n(src/ui/menu/attractions.py)"]:::ui
        reviews["Reviews Menu\n(src/ui/menu/reviews.py)"]:::ui
        filters["Filters Menu\n(src/ui/menu/filters.py)"]:::ui
        analyzerMenu["Analyzer Menu\n(src/ui/menu/analyzer.py)"]:::ui
        results["Results Menu\n(src/ui/menu/results.py)"]:::ui
    end

    %% Data Flow
    Ext -->|HTTP Requests| networking
    networking --> scraper
    scraper --> parser
    parser --> datahandler
    datahandler --> rawdata
    datahandler --> consolidated
    consolidated --> analyzer
    analyzer --> metrics
    metrics --> uiapp
    uiapp --> exporters
    exporters --> consolidated

    %% Control & Config
    constants --> networking
    constants --> scraper
    constants --> datahandler
    constants --> analyzer
    constants --> uiapp

    %% UI Interactions
    uiapp --> home
    uiapp --> attractions
    uiapp --> reviews
    uiapp --> filters
    uiapp --> analyzerMenu
    uiapp --> results

    %% Logging
    networking --> logger
    scraper --> logger
    parser --> logger
    datahandler --> logger
    analyzer --> logger
    metrics --> logger
    exporters --> logger
    uiapp --> logger

    %% Click Events
    click networking "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/utils/networking.py"
    click scraper "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/core/scraper.py"
    click parser "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/core/parsers/review_parser.py"
    click datahandler "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/core/data_handler.py"
    click analyzer "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/core/analyzer.py"
    click metrics "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/core/metrics.py"
    click exporters "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/utils/exporters.py"
    click logger "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/utils/logger.py"
    click constants "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/utils/constants.py"
    click constants "https://github.com/ignacioe7/proyectodetitulo/blob/main/config.json"
    click rawdata "https://github.com/ignacioe7/proyectodetitulo/blob/main/data/regions/regions.json"
    click consolidated "https://github.com/ignacioe7/proyectodetitulo/blob/main/data/consolidated_data.json"
    click uiapp "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/ui/streamlit_app.py"
    click home "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/ui/menu/home.py"
    click attractions "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/ui/menu/attractions.py"
    click reviews "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/ui/menu/reviews.py"
    click filters "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/ui/menu/filters.py"
    click analyzerMenu "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/ui/menu/analyzer.py"
    click results "https://github.com/ignacioe7/proyectodetitulo/blob/main/src/ui/menu/results.py"

    %% Styles
    classDef external fill:#D6E9C6,stroke:#3C763D,color:#3C763D;
    classDef backend fill:#D9EDF7,stroke:#31708F,color:#31708F;
    classDef data fill:#FCF8E3,stroke:#8A6D3B,color:#8A6D3B;
    classDef ui fill:#F2DEDE,stroke:#A94442,color:#A94442;
    classDef utility fill:#EEEEEE,stroke:#666666,color:#333333;
```
