# eckarthik/hideme architecture

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

- Interactive diagram: https://gitdiagram.com/eckarthik/hideme
- Repository: https://github.com/eckarthik/hideme

## Overview

##### Project type and purpose
- HideMe is an open-source Python library whose sole purpose is to fetch and return a list of free proxy servers by scraping public proxy-listing websites. There is no frontend UI or persistent data store—this is a standalone utility package.

##### File structure
- Top level:
- .gitignore, .travis.yml, LICENSE, README.md (repo metadata & CI)
- tests.py (unit/integration tests)
- hideme/ (package directory)
- hideme/ contains:
- __init__.py (package entry point)
- proxy_collector.py (main scraper and filter logic)
- user_agents.txt (static list of User-Agent strings used when making HTTP requests)

##### Pulling in README insights
- Core class: ProxiesList
- API: ProxiesList(...filters...) → get(count=N) → returns a list of dicts with proxy attributes
- No external dependencies beyond Python HTTP and parsing libraries (requests, BeautifulSoup, etc., implied)

##### Main components
a) Client / Consumer Code
- Your application or script that does:
from hideme.proxy_collector import ProxiesList
proxies = ProxiesList(...).get()
b) HideMe Library
- ProxyCollector Module:
- HTTP Request Layer
- HTML Parser
- Filter Engine (applies country, https, port, google_support)
- Data Model (proxy entry dict)
- user_agents.txt (resource file)
c) External Services
- Free proxy websites (one or multiple URLs) that ProxyCollector scrapes
d) Test Runner (tests.py) and CI (Travis) – optional side notes

##### Relationships and interactions
- Client → invokes ProxyCollector API
- ProxyCollector → reads user_agents.txt → selects a User-Agent header
- ProxyCollector → issues HTTP GETs to external proxy websites
- Response → parsed by HTML Parser → raw proxy data extracted
- Filter Engine → applies user-provided filters (country, https, port, google_support)
- Returns → list of standardized proxy dicts to Client

##### Architectural patterns / design principles
- Single-responsibility modules: HTTP layer, parsing, filtering
- Resource-based architecture: static user agents file separated from code
- Open-source tool emphasis on simplicity and modularity

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Repository"
        RepoMetadata["README.md & LICENSE"] 
        GitIgnore[".gitignore"]
        CI[".travis.yml"]
        Tests["tests.py"]
    end

    Client["Client / Consumer"]

    subgraph "HideMe Library"
        direction TB
        Entry["Package Entry Point"] 
        API["ProxiesList API"]
        HTTP["HTTP Request Module"]
        Resource["Resource Loader\n(user_agents.txt)"]
        Parser["HTML Parser"]
        Filter["Filter Engine"]
        Model["Data Model"]
    end

    External["External Proxy Sites"]

    Client -->|uses| API
    API -->|calls| HTTP
    Resource -->|feeds| HTTP
    HTTP -->|fetches from| External
    External -->|returns HTML| Parser
    Parser -->|extracts data| Filter
    Filter -->|applies filters| Model
    Model -->|returns list| Client

    click API "https://github.com/eckarthik/hideme/blob/master/hideme/proxy_collector.py"
    click HTTP "https://github.com/eckarthik/hideme/blob/master/hideme/proxy_collector.py"
    click Parser "https://github.com/eckarthik/hideme/blob/master/hideme/proxy_collector.py"
    click Filter "https://github.com/eckarthik/hideme/blob/master/hideme/proxy_collector.py"
    click Model "https://github.com/eckarthik/hideme/blob/master/hideme/proxy_collector.py"
    click Resource "https://github.com/eckarthik/hideme/blob/master/hideme/user_agents.txt"
    click Entry "https://github.com/eckarthik/hideme/blob/master/hideme/__init__.py"
    click Tests "https://github.com/eckarthik/hideme/blob/master/tests.py"
    click CI "https://github.com/eckarthik/hideme/blob/master/.travis.yml"
    click RepoMetadata "https://github.com/eckarthik/hideme/blob/master/README.md"
    click GitIgnore "https://github.com/eckarthik/hideme/blob/master/.gitignore"

    classDef internal fill:#D6EAF8,stroke:#2980B9
    classDef external fill:#ABEBC6,stroke:#239B56
    classDef resource fill:#FCF3CF,stroke:#B7950B
    classDef side stroke-dasharray:5 5,stroke:#7F8C8D

    class Entry,API,HTTP,Parser,Filter,Model internal
    class Client,External external
    class Resource resource
    class RepoMetadata,GitIgnore,CI,Tests side
```
