# olaowo5/ola_osint architecture

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

- Interactive diagram: https://gitdiagram.com/olaowo5/ola_osint
- Repository: https://github.com/olaowo5/ola_osint

## Overview

##### Main Components
- Core Application – represented by main.py, which is the entry point.
- External APIs & Services – include dependencies like Google Search Engine API, Have I Been Pwned API, WHOIS, Holehe, and the HudsonRock service. These should be depicted as external modules that the core application communicates with.
- Data Files & Resources – include static files and configuration data (e.g., AccountSearch/list.txt and AccountSearch/services.txt), image files used for UI elements (e.g., Images folder), as well as folders for saving results (Saves) and user settings (Settings). These elements show how the tool manages input and output data.
- Dependency Management – This is implied by requirements.txt and should be noted to indicate third-party libraries integration.

##### Relationships and Interactions
- The main.py script functions as the central hub, gathering inputs (possibly from the command line or a UI) and orchestrating calls to various OSINT modules.
- The AccountSearch directory contains essential data (usernames and associated services) needed by lookup functions; represent this as a data source component connected to the service handling username-related queries.
- Folders like Saves and Settings should connect to the main application to show how state (such as results or configuration preferences) is persisted.

##### Architectural Patterns & Design Principles
- Presentation/Input Layer: Handling user commands and displaying output.
- Business Logic/Control Layer: Containing the logic for all OSINT functionalities.
- Integration Layer: Handling communication with external APIs.
- Persistence Layer: Saving results and user settings.
- This separation not only clarifies the interactions but also highlights potential modularity if the project grows.
- That the project follows a loosely coupled architecture where each feature module interacts with a specific external service, promoting clarity in dependencies.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "User Interaction"
        UI["User Input (CLI/GUI)"]:::presentation
    end

    subgraph "Business Logic"
        core["Core Application\n(main.py)"]:::core
        subgraph "OSINT Feature Modules"
            ip["IP Lookup Module"]:::osint
            username["Username Lookup Module"]:::osint
            phone["Phone Lookup Module"]:::osint
            domain["Domain Lookup Module"]:::osint
            email["Email Lookup Module"]:::osint
        end
        core --> ip
        core --> username
        core --> phone
        core --> domain
        core --> email
    end

    subgraph "Integration Layer"
        google["Google Search API"]:::external
        pwned["HaveIBeenPwned API"]:::external
        whois["WHOIS Service"]:::external
        holehe["Holehe Service"]:::external
        hudson["HudsonRock Service"]:::external
    end

    subgraph "Persistence Layer"
        account["Lookup Data\n(AccountSearch)"]:::data
        images["UI/Image Resources\n(Images)"]:::data
        saves["Saved Results\n(Saves)"]:::data
        settings["User Settings\n(Settings)"]:::data
    end

    subgraph "Dependency Management"
        dep["requirements.txt"]:::dep
    end

    UI --> core
    ip --> whois
    username --> pwned
    phone --> holehe
    domain --> google
    email --> hudson

    core --> account
    core --> images
    core --> saves
    core --> settings
    core --> dep

    click core "https://github.com/olaowo5/ola_osint/blob/main/main.py"
    click account "https://github.com/olaowo5/ola_osint/tree/main/AccountSearch"
    click images "https://github.com/olaowo5/ola_osint/tree/main/Images"
    click saves "https://github.com/olaowo5/ola_osint/tree/main/Saves"
    click settings "https://github.com/olaowo5/ola_osint/tree/main/Settings"
    click dep "https://github.com/olaowo5/ola_osint/blob/main/requirements.txt"

    classDef core fill:#b3e5fc,stroke:#039be5,stroke-width:2px;
    classDef osint fill:#c8e6c9,stroke:#2e7d32,stroke-width:2px;
    classDef external fill:#ffe082,stroke:#ffa000,stroke-width:2px;
    classDef data fill:#d1c4e9,stroke:#673ab7,stroke-width:2px;
    classDef dep fill:#ffccbc,stroke:#e64a19,stroke-width:2px;
    classDef presentation fill:#ffab91,stroke:#d84315,stroke-width:2px;
```
