# harry3602/resume-builder-using-nlp architecture

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

- Interactive diagram: https://gitdiagram.com/harry3602/resume-builder-using-nlp
- Repository: https://github.com/harry3602/resume-builder-using-nlp

## Overview

##### Project Type and Purpose
- Project type: a CLI/open-source tool for automated resume generation.
- Purpose: read candidate data + job description from JSON, extract/match skills with NLP, and produce a `.docx` resume.

##### Main Components
a. Input Layer
- JSON File (`input.json`)
- CLI Invocation (`python resume_builder.py`)
b. NLP Processing Module
- spaCy Model (`en_core_web_sm`)
- Text extraction & keyword matching sub-component
c. Resume Generation Module
- Objective Generator
- Section Builders (Education, Experience, Skills, Projects, Certificates)
- python-docx Integration
d. Output Layer
- Generated Word Document (`generated_resume.docx`)
e. Environment & Dependencies
- Python Runtime (3.8+)
- Virtual Environment (`venv`)
- External Libraries (`spacy`, `python-docx`)

##### Architectural Patterns & Principles
- Modular design: separate parser, NLP logic, document builder
- Single responsibility: each component has one clear purpose
- Dependency injection: pass parsed data into NLP and builder modules

##### Detailed Breakdown
Top row:
[ input.json ] —> [ JSON Parser ]
Middle row (left to right):
[ JSON Parser ] —> [ NLP Processing ] —> [ Resume Builder ]
Bottom row:
[ Resume Builder ] —> [ generated_resume.docx ]
Off to the side:
- python-docx library (connects to Resume Builder)

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Python Runtime (3.8+)"
        direction TB
        A["input.json"]:::io
        B["JSON Parser"]:::proc
        C["NLP Processing"]:::proc
        D["Resume Builder"]:::proc
        E["generated_resume.docx"]:::io

        A -->|"raw text & JSON data"| B
        B -->|"parsed data"| C
        C -->|"extracted skills/objectives"| D
        D -->|".docx file"| E
    end

    sp["spaCy Model"]:::ext
    pd["python-docx Library"]:::ext
    Rq["requirements.txt"]:::ext
    Rd["README.md"]:::ext

    sp -.-> C
    pd -.-> D
    Rq -.-> C
    Rq -.-> D

    click A "https://github.com/harry3602/resume-builder-using-nlp/blob/main/input.json"
    click B "https://github.com/harry3602/resume-builder-using-nlp/blob/main/resume_builder.py"
    click C "https://github.com/harry3602/resume-builder-using-nlp/blob/main/resume_builder.py"
    click D "https://github.com/harry3602/resume-builder-using-nlp/blob/main/resume_builder.py"
    click Rq "https://github.com/harry3602/resume-builder-using-nlp/blob/main/requirements.txt"
    click Rd "https://github.com/harry3602/resume-builder-using-nlp/blob/main/README.md"

    classDef io fill:#D0E8FF,stroke:#0366d6,stroke-width:1px
    classDef proc fill:#D0FFD0,stroke:#228B22,stroke-width:1px
    classDef ext fill:#FFE0B2,stroke:#FF8C00,stroke-width:1px
```
