Skip to content

Reference: Repository Structure

This is the practical map of the current repository layout.

Top-Level Directories

  • src/url_monitor/ application source
  • tests/ test suite
  • docs/ MkDocs content
  • .github/workflows/ CI/CD workflows
  • scripts/ helper scripts
  • data/ runtime local data (created/used at runtime)

Application Source

src/url_monitor/core/

Core runtime logic:

  • mitm_addon.py request/response inspection pipeline
  • filter_manager.py filters, updates, matching, stats
  • database.py SQLite access layer
  • alerts.py notification wrappers
  • block_pages.py synthetic block page HTML

src/url_monitor/qt/

Desktop UI:

  • main_window.py shell orchestration
  • panels/ dashboard/live/settings views
  • backend/ monitor manager, workers, cert manager, signals
  • widgets/ reusable UI components
  • styles/ theme/color system
  • branding.py logo, links, feed/license metadata

src/url_monitor/i18n/

Locale support and normalization helpers.

Runtime Data Paths

Configured in Config:

  • data/settings.json
  • data/url_monitor.db
  • data/filters/ (including uBlock filter file)

Test Suite

The tests/ folder includes:

  • core behavior tests
  • config tests
  • i18n tests
  • Qt panel and runtime regression tests
  • worker/load behavior tests

Documentation Layout

Current docs are bilingual:

  • docs/en/...
  • docs/es/...

Root docs/index.md is language landing.