# ml1ups/resume-classifier architecture

> Architecture diagram of the GitHub repository ml1ups/resume-classifier, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ml1ups/resume-classifier
- Repository: https://github.com/ml1ups/resume-classifier

## Overview

This repository currently implements an asynchronous FastAPI service for operational endpoints, not resume classification itself. The runtime workflow starts the app, creates a PostgreSQL pool, and serves liveness, dependency-health, and version responses; request logging and configuration support that flow. The README describes data preparation, model training, versioning, and monitoring as broader project goals, but the source tree shown contains no prediction or ML pipeline implementation. Connections reflect excerpts and README statements; unsampled capabilities are not inferred.

Main entry points: [`src/resume_classifier/main.py`](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/main.py) (App lifecycle), [`src/resume_classifier/__main__.py`](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/__main__.py) (CLI entrypoint), [`src/resume_classifier/api/v1/health.py`](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/api/v1/health.py) (Health endpoint), [`src/resume_classifier/db.py`](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/db.py) (PostgreSQL access)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Service runtime"]
  node_entrypoint["CLI entrypoint<br/>[__main__.py]"]
  node_app["App lifecycle<br/>[main.py]"]
end

subgraph group_api["Service API"]
  node_liveness["Liveness endpoint<br/>[healthz.py]"]
  node_api_router["API v1 router<br/>[__init__.py]"]
  node_health["Health endpoint<br/>[health.py]"]
  node_version["Version endpoint<br/>[version.py]"]
end

subgraph group_dependencies["Dependencies and support"]
  node_checks["Health checks<br/>[checks.py]"]
  node_database["PostgreSQL access<br/>[db.py]"]
  node_settings["Settings<br/>[config.py]"]
  node_logging["Logging middleware<br/>[logs.py]"]
  node_schemas["Response schemas<br/>[schemas.py]"]
end

node_operator(("Service operator"))
node_client(("API client"))
node_postgres[("PostgreSQL")]

node_operator -.->|"starts"| node_entrypoint
node_entrypoint -->|"creates app"| node_app
node_entrypoint -->|"loads settings"| node_settings
node_entrypoint -->|"configures logs"| node_logging
node_app -->|"loads defaults"| node_settings
node_app -->|"creates pool"| node_database
node_app -->|"installs middleware"| node_logging
node_app -->|"registers router"| node_liveness
node_app -->|"registers router"| node_api_router
node_client -.->|"sends requests"| node_app
node_api_router -->|"includes route"| node_health
node_api_router -->|"includes route"| node_version
node_health -->|"collects health"| node_checks
node_health -->|"reads timeout"| node_settings
node_checks -->|"checks version"| node_database
node_database -->|"configures pool"| node_settings
node_database -->|"queries version"| node_postgres
node_liveness -->|"returns schema"| node_schemas
node_health -->|"returns schema"| node_schemas
node_version -->|"returns schema"| node_schemas

click node_entrypoint "https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/__main__.py"
click node_app "https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/main.py"
click node_liveness "https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/api/healthz.py"
click node_api_router "https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/api/v1/__init__.py"
click node_health "https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/api/v1/health.py"
click node_version "https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/api/v1/version.py"
click node_checks "https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/checks.py"
click node_database "https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/db.py"
click node_settings "https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/config.py"
click node_logging "https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/logs.py"
click node_schemas "https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/schemas.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entrypoint,node_app,node_client toneBlue
class node_liveness,node_api_router,node_health,node_version,node_postgres toneAmber
class node_checks,node_database,node_settings,node_logging,node_schemas toneMint
class node_operator toneIndigo
```

## Components

### Service runtime

- [CLI entrypoint](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/__main__.py): `src/resume_classifier/__main__.py`
- [App lifecycle](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/main.py): `src/resume_classifier/main.py`

### Service API

- [Liveness endpoint](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/api/healthz.py): `src/resume_classifier/api/healthz.py`
- [API v1 router](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/api/v1/__init__.py): `src/resume_classifier/api/v1/__init__.py`
- [Health endpoint](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/api/v1/health.py): `src/resume_classifier/api/v1/health.py`
- [Version endpoint](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/api/v1/version.py): `src/resume_classifier/api/v1/version.py`

### Dependencies and support

- [Health checks](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/checks.py): `src/resume_classifier/checks.py`
- [PostgreSQL access](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/db.py): `src/resume_classifier/db.py`
- [Settings](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/config.py): `src/resume_classifier/config.py`
- [Logging middleware](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/logs.py): `src/resume_classifier/logs.py`
- [Response schemas](https://github.com/ml1ups/resume-classifier/blob/main/src/resume_classifier/schemas.py): `src/resume_classifier/schemas.py`

### Other components

- **Service operator**
- **API client**
- **PostgreSQL**

## Connections

- Service operator → CLI entrypoint: starts
- CLI entrypoint → App lifecycle: creates app (evidence: `src/resume_classifier/__main__.py`)
- CLI entrypoint → Settings: loads settings (evidence: `src/resume_classifier/__main__.py`)
- CLI entrypoint → Logging middleware: configures logs (evidence: `src/resume_classifier/__main__.py`)
- App lifecycle → Settings: loads defaults (evidence: `src/resume_classifier/main.py`)
- App lifecycle → PostgreSQL access: creates pool (evidence: `src/resume_classifier/main.py`)
- App lifecycle → Logging middleware: installs middleware (evidence: `src/resume_classifier/main.py`)
- App lifecycle → Liveness endpoint: registers router (evidence: `src/resume_classifier/main.py`)
- App lifecycle → API v1 router: registers router (evidence: `src/resume_classifier/main.py`)
- API client → App lifecycle: sends requests
- API v1 router → Health endpoint: includes route (evidence: `src/resume_classifier/api/v1/__init__.py`)
- API v1 router → Version endpoint: includes route (evidence: `src/resume_classifier/api/v1/__init__.py`)
- Health endpoint → Health checks: collects health (evidence: `src/resume_classifier/api/v1/health.py`)
- Health endpoint → Settings: reads timeout (evidence: `src/resume_classifier/api/v1/health.py`)
- Health checks → PostgreSQL access: checks version (evidence: `src/resume_classifier/checks.py`)
- PostgreSQL access → Settings: configures pool (evidence: `src/resume_classifier/db.py`)
- PostgreSQL access → PostgreSQL: queries version (evidence: `src/resume_classifier/db.py`)
- Liveness endpoint → Response schemas: returns schema (evidence: `src/resume_classifier/api/healthz.py`)
- Health endpoint → Response schemas: returns schema (evidence: `src/resume_classifier/api/v1/health.py`)
- Version endpoint → Response schemas: returns schema (evidence: `src/resume_classifier/api/v1/version.py`)
