# bradykim7/pbot architecture

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

- Interactive diagram: https://gitdiagram.com/bradykim7/pbot
- Repository: https://github.com/bradykim7/pbot

## Overview

##### Project type and purpose
- This is a multi‐service Python project comprising two microservices:
- Hybabot: a Discord bot offering game info, music playback, recommendations, etc.
- Pricesota: a web crawler that scrapes product deals and notifies via Discord.
- Both run in Docker containers and share a MongoDB instance; they interact with external services (Discord API, FFmpeg).

##### File structure
- Top‐level folders:
- hybabot/ – Discord bot code (entry point newbot.py, cogs, shared utilities, models, repos)
- pricesota/ – Web crawler code under src/ (configs, infrastructure/crawler, library, product/domain, service layer, utils, main.py)
- Dockerfile & Dockerfile_webcrawler – build containers for each service
- docker-compose.yml – orchestrates both services plus MongoDB
- Patterns & layering:
- Hybabot uses a command‐module pattern (cogs) with shared common models and repositories.
- Pricesota uses a layered domain‐driven structure (configs → infrastructure → domain/models/repositories → service → utils).

##### README insights
- Required services: MongoDB, FFmpeg, Discord API
- Deployment: environment variables via .env, Docker Compose for containers
- Features that drive architecture: bot command handling, music streaming, crawling with multiple adapters, notification publishing

##### Main components
- Hybabot Service (Docker Container)
- Discord Command Handler (cogs)
- Shared Common Layer (models, repositories, utils)
- Hero & Food Domain Modules (models + repos)
- Public Assets (static text files)
- Config & Constants modules
- FFmpeg subsystem (external dependency)
- Pricesota Service (Docker Container)
- Crawler Layer (PpomppuCrawler, QuasarzoneCrawler, generic WebCrawler)
- Domain Layer (product models, keyword alerts)
- Repository Layer (KeywordAlertRepository, ProductRepository)
- Service Layer (ProductService)
- Notification Library (DiscordLibrary)
- NLP utilities
- Config & Utils
- Shared Database
- MongoDB (collections for alerts, products, heroes, food)
- External Services
- Discord API (bot commands & notifications)
- FFmpeg (audio processing)

##### Relationships and data flows
- Hybabot: Discord API ←→ Command Handler → Repository → MongoDB
- Hybabot: Music commands → FFmpeg → Audio stream
- Pricesota: Scheduler/trigger → Crawler modules → ProductService → Repository → MongoDB
- Pricesota: On new deals → DiscordLibrary → Discord API
- Both containers connect to the same MongoDB instance defined in docker-compose

##### Architectural patterns & design principles
- Microservices: two distinct services in separate containers
- Layered architecture within each service (presentation/commands, domain, persistence, utilities)
- Adapter pattern for crawlers and notification library
- Dependency injection via config modules and environment variables

##### Technologies, frameworks, libraries
- Python 3.8+
- Discord.py (Discord interactions)
- youtube-dl & FFmpeg (music playback)
- MongoDB (persistent storage)
- Docker & Docker Compose (containerization)
- Custom crawler adapters for web scraping

- Component labels (e.g., “Hybabot Cogs”, “ProductService”)
- Grouped layers (e.g., “Domain”, “Infrastructure”, “Utilities”)
- Environment boundary (Docker Compose network)

## Diagram (Mermaid)

```mermaid
graph TD
  subgraph "Docker Compose Network"
    direction TB

    subgraph "Hybabot Service"
      direction TB
      HB_Entry["Entry Point: newbot.py"]:::frontend
      Cogs["Discord Command Handler (Cogs)"]:::frontend
      ModelsShared["Shared Common Layer"]:::frontend
      ReposShared["Shared Repository Layer"]:::frontend
      UtilsShared["Shared Utilities"]:::frontend
      HeroModel["Hero Domain Model"]:::frontend
      HeroRepo["Hero Repository"]:::frontend
      FoodModel["Food Domain Model"]:::frontend
      FoodRepo["Food Repository"]:::frontend
      PublicAssets["Public Assets (.txt)"]:::frontend
      ConfigsHB["Configurations & Constants"]:::frontend
      FFmpegDep["FFmpeg/youtube-dl Subsystem"]:::external
    end

    subgraph "Pricesota Service"
      direction TB
      PS_Entry["Entry Point: main.py"]:::backend
      Crawlers["Crawler Layer"]:::backend
      DomainPS["Domain Models"]:::backend
      RepoPS["Repository Layer"]:::backend
      ServicePS["Service Layer: ProductService"]:::backend
      DiscordLib["Notification Library"]:::backend
      NLP["NLP Utilities"]:::backend
      ConfigsPS["Configurations & Utils"]:::backend
      Migration["Database Migration Script"]:::backend
    end

    MongoDB["MongoDB"]:::db
    DiscordAPI["Discord API"]:::external

  end

  %% Connections - Hybabot
  HB_Entry -->|loads| Cogs
  Cogs -->|uses models| ModelsShared
  Cogs -->|uses repos| ReposShared
  ModelsShared -->|defines schemas| ReposShared
  ReposShared -->|read/write| MongoDB
  Cogs -->|uses| HeroRepo
  HeroRepo -->|read/write| MongoDB
  Cogs -->|uses| FoodRepo
  FoodRepo -->|read/write| MongoDB
  Cogs -->|calls| DiscordAPI
  Cogs -->|streams audio via| FFmpegDep

  ConfigsHB --> HB_Entry
  UtilsShared --> Cogs

  %% Connections - Pricesota
  PS_Entry -->|triggers| Crawlers
  Crawlers -->|calls| ServicePS
  ServicePS -->|calls| RepoPS
  RepoPS -->|read/write| MongoDB
  DomainPS -->|defines| RepoPS
  ServicePS -->|publishes| DiscordLib
  DiscordLib -->|calls| DiscordAPI
  NLP -->|used by| Crawlers
  ConfigsPS --> PS_Entry
  Migration --> PS_Entry

  %% Shared Database
  MongoDB -->|connected| Hybabot_Service
  MongoDB -->|connected| Pricesota_Service

  %% Click Events
  click HB_Entry "https://github.com/bradykim7/pbot/blob/main/hybabot/newbot.py"
  click Cogs "https://github.com/bradykim7/pbot/tree/main/hybabot/cogs/"
  click ModelsShared "https://github.com/bradykim7/pbot/tree/main/hybabot/common/"
  click ReposShared "https://github.com/bradykim7/pbot/tree/main/hybabot/common/"
  click UtilsShared "https://github.com/bradykim7/pbot/tree/main/hybabot/common/utils/"
  click HeroModel "https://github.com/bradykim7/pbot/blob/main/hybabot/hero/models/hero.py"
  click HeroRepo "https://github.com/bradykim7/pbot/blob/main/hybabot/hero/repositories/hero_repository.py"
  click FoodModel "https://github.com/bradykim7/pbot/blob/main/hybabot/food/models/food.py"
  click FoodRepo "https://github.com/bradykim7/pbot/blob/main/hybabot/food/repositories/food_repository.py"
  click PublicAssets "https://github.com/bradykim7/pbot/tree/main/hybabot/public/hots/"
  click ConfigsHB "https://github.com/bradykim7/pbot/tree/main/hybabot/configs/"
  click FFmpegDep "https://github.com/bradykim7/pbot/tree/main/hybabot/bin_rg/youtube-dl"

  click PS_Entry "https://github.com/bradykim7/pbot/blob/main/pricesota/src/main.py"
  click Crawlers "https://github.com/bradykim7/pbot/tree/main/pricesota/src/infrastructure/crawler/"
  click DomainPS "https://github.com/bradykim7/pbot/tree/main/pricesota/src/product/models/"
  click RepoPS "https://github.com/bradykim7/pbot/tree/main/pricesota/src/product/repository/"
  click ServicePS "https://github.com/bradykim7/pbot/blob/main/pricesota/src/product/service/ProductService.py"
  click DiscordLib "https://github.com/bradykim7/pbot/blob/main/pricesota/src/library/DiscordLibrary.py"
  click NLP "https://github.com/bradykim7/pbot/blob/main/pricesota/src/library/nlp.py"
  click ConfigsPS "https://github.com/bradykim7/pbot/tree/main/pricesota/src/configs/"
  click Migration "https://github.com/bradykim7/pbot/blob/main/pricesota/migration.py"

  %% Styles
  classDef frontend fill:#cfe2ff,stroke:#084298,color:#084298;
  classDef backend fill:#d1e7dd,stroke:#0f5132,color:#0f5132;
  classDef external fill:#fff3cd,stroke:#664d03,color:#664d03;
  classDef db fill:#f8d7da,stroke:#842029,color:#842029;
```
