# aswind-s-varman/jd-match architecture

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

- Interactive diagram: https://gitdiagram.com/aswind-s-varman/jd-match
- Repository: https://github.com/aswind-s-varman/jd-match

## Overview

jd-match compares a resume with a job description through a web or command-line interface. Both workflows read resume text, compare canonical skill sets, inspect DOCX structure for ATS risks, and expose matched, missing, extra, and coverage results; they also extract job-description requirements, including unrecognised terms. The CLI renders a text report, while the web interface presents results directly. The graph follows the sampled callers and README architecture; no storage or network service is documented.

Main entry points: [`app.py`](https://github.com/aswind-s-varman/jd-match/blob/main/app.py) (Web interface), [`src/jd_match/cli.py`](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/cli.py) (CLI), [`src/jd_match/matcher.py`](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/matcher.py) (Skill comparison), [`src/jd_match/keywords.py`](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/keywords.py) (Keyword matching)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interfaces["User interfaces"]
  node_web["Web interface<br/>[app.py]"]
  node_cli["CLI<br/>[cli.py]"]
end

subgraph group_analysis["Text analysis"]
  node_extract["Text extraction<br/>[extract.py]"]
  node_matcher["Skill comparison<br/>[matcher.py]"]
  node_keywords["Keyword matching<br/>[keywords.py]"]
  node_vocabulary["Skill vocabulary<br/>[skills.py]"]
  node_requirements["Requirement extraction<br/>[requirements.py]"]
end

subgraph group_documents["Document checks"]
  node_ats["ATS structure checks<br/>[ats_checks.py]"]
end

subgraph group_output["Results"]
  node_report["Text report<br/>[report.py]"]
  node_web_results["Web results<br/>[app.py]"]
  node_cli_results["CLI output<br/>[cli.py]"]
end

node_user(("User"))

node_user -->|"uploads and submits"| node_web
node_user -->|"provides files"| node_cli
node_web -->|"extracts uploaded resume"| node_extract
node_cli -->|"reads resume and posting"| node_extract
node_web -->|"compares text"| node_matcher
node_cli -->|"compares text"| node_matcher
node_web -->|"extracts posting requirements"| node_requirements
node_cli -->|"extracts posting requirements"| node_requirements
node_web -->|"checks resume structure"| node_ats
node_cli -->|"checks resume structure"| node_ats
node_matcher -->|"finds skills"| node_keywords
node_requirements -->|"recognises skills"| node_keywords
node_keywords -->|"resolves aliases"| node_vocabulary
node_cli -->|"renders comparison"| node_report
node_report -->|"returns text"| node_cli_results
node_web -->|"displays results"| node_web_results

click node_web "https://github.com/aswind-s-varman/jd-match/blob/main/app.py"
click node_cli "https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/cli.py"
click node_extract "https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/extract.py"
click node_matcher "https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/matcher.py"
click node_keywords "https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/keywords.py"
click node_vocabulary "https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/skills.py"
click node_requirements "https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/requirements.py"
click node_ats "https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/ats_checks.py"
click node_report "https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/report.py"
click node_web_results "https://github.com/aswind-s-varman/jd-match/blob/main/app.py"
click node_cli_results "https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/cli.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_web,node_cli,node_user toneBlue
class node_extract,node_matcher,node_keywords,node_vocabulary,node_requirements toneAmber
class node_ats toneMint
class node_report,node_web_results,node_cli_results toneRose
```

## Components

### User interfaces

- [Web interface](https://github.com/aswind-s-varman/jd-match/blob/main/app.py): `app.py`
- [CLI](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/cli.py): `src/jd_match/cli.py`

### Text analysis

- [Text extraction](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/extract.py): `src/jd_match/extract.py`
- [Skill comparison](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/matcher.py): `src/jd_match/matcher.py`
- [Keyword matching](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/keywords.py): `src/jd_match/keywords.py`
- [Skill vocabulary](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/skills.py): `src/jd_match/skills.py`
- [Requirement extraction](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/requirements.py): `src/jd_match/requirements.py`

### Document checks

- [ATS structure checks](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/ats_checks.py): `src/jd_match/ats_checks.py`

### Results

- [Text report](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/report.py): `src/jd_match/report.py`
- [Web results](https://github.com/aswind-s-varman/jd-match/blob/main/app.py): `app.py`
- [CLI output](https://github.com/aswind-s-varman/jd-match/blob/main/src/jd_match/cli.py): `src/jd_match/cli.py`

### Other components

- **User**

## Connections

- User → Web interface: uploads and submits (evidence: `README.md`)
- User → CLI: provides files (evidence: `README.md`)
- Web interface → Text extraction: extracts uploaded resume (evidence: `app.py`)
- CLI → Text extraction: reads resume and posting (evidence: `src/jd_match/cli.py`)
- Web interface → Skill comparison: compares text (evidence: `app.py`)
- CLI → Skill comparison: compares text (evidence: `src/jd_match/cli.py`)
- Web interface → Requirement extraction: extracts posting requirements (evidence: `app.py`)
- CLI → Requirement extraction: extracts posting requirements (evidence: `src/jd_match/cli.py`)
- Web interface → ATS structure checks: checks resume structure (evidence: `app.py`)
- CLI → ATS structure checks: checks resume structure (evidence: `src/jd_match/cli.py`)
- Skill comparison → Keyword matching: finds skills (evidence: `src/jd_match/matcher.py`)
- Requirement extraction → Keyword matching: recognises skills (evidence: `src/jd_match/requirements.py`)
- Keyword matching → Skill vocabulary: resolves aliases (evidence: `src/jd_match/keywords.py`)
- CLI → Text report: renders comparison (evidence: `src/jd_match/cli.py`)
- Text report → CLI output: returns text (evidence: `src/jd_match/cli.py`)
- Web interface → Web results: displays results (evidence: `app.py`)
