# avelazquez97/serverchecker architecture

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

- Interactive diagram: https://gitdiagram.com/avelazquez97/serverchecker
- Repository: https://github.com/avelazquez97/serverchecker

## Overview

##### Project type and purpose
- This is a small command-line Python utility (“ServerChecker”) whose sole responsibility is to read a list of domains, resolve their A and PTR DNS records, and emit a CSV report.
- There is no frontend or persistent database—just a linear data-processing pipeline.

##### File structure
- Top-level files:
- checkServer  — the executable Python script
- README.md  — project description and usage
- .gitattributes — Git metadata (irrelevant to runtime)
- No subdirectories, no web server, no external services beyond DNS.

##### README for insights
- Flow steps are clearly outlined:
1) Validate input file (.in)
2) Read domains list
3) Resolve A record, then PTR record
4) Write results to a CSV file
- Uses only Python standard libraries for DNS lookups and file I/O.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External actor
    User((User)):::external

    %% Processing stages
    CLI["CLI Frontend\n(checkServer)"]:::processing
    Decision{"Valid .in file?"}:::decision
    Reader["Input File Reader\n(checkServer)"]:::processing
    DNS["DNS Resolver Module\n(checkServer)"]:::processing
    Agg["Result Aggregator\n(checkServer)"]:::processing
    Writer["CSV Writer\n(checkServer)"]:::processing

    %% IO components
    FileIn[(Domains List Input File)]:::io
    FileOut[(Output CSV File)]:::io

    %% Network
    NetStack["Network Stack\n(UDP/TCP DNS queries)"]:::network

    %% Documentation
    Doc["Project Documentation\n(README.md)"]:::doc

    %% Data flow
    User -->|"invokes"| CLI
    CLI -->|"parses arguments"| Decision
    Decision -->|Yes| Reader
    Decision -->|No| CLI
    Reader -->|"reads domains"| FileIn
    Reader -->|"feeds domains"| DNS
    DNS -->|"sends queries"| NetStack
    NetStack -->|"returns records"| DNS
    DNS -->|"returns A & PTR records"| Agg
    Agg -->|"aggregates results"| Writer
    Writer -->|"writes CSV"| FileOut
    FileOut -->|"emits to user"| User
    CLI -.->|uses docs| Doc

    %% Click events
    click CLI "https://github.com/avelazquez97/serverchecker/tree/main/checkServer"
    click Reader "https://github.com/avelazquez97/serverchecker/tree/main/checkServer"
    click DNS "https://github.com/avelazquez97/serverchecker/tree/main/checkServer"
    click Agg "https://github.com/avelazquez97/serverchecker/tree/main/checkServer"
    click Writer "https://github.com/avelazquez97/serverchecker/tree/main/checkServer"
    click Doc "https://github.com/avelazquez97/serverchecker/blob/main/README.md"

    %% Styles
    classDef processing fill:#D0E7FF,stroke:#0366D6
    classDef io fill:#F0F0F0,stroke:#666666,stroke-dasharray: 4 2
    classDef network fill:#E6FFFA,stroke:#2C7A7B
    classDef decision fill:#FFE4B5,stroke:#CC5500,stroke-dasharray: 2 2
    classDef external fill:#FFF5BA,stroke:#C58940
    classDef doc fill:#FFEFF0,stroke:#D73A49,stroke-dasharray: 2 2
```
