# sanskaromar/certifai architecture

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

- Interactive diagram: https://gitdiagram.com/sanskaromar/certifai
- Repository: https://github.com/sanskaromar/certifai

## Overview

##### Project Type and Purpose
- Certifai is a Python-based certificate generator (an open-source tool/CLI application).
- It reads tabular data (CSV), populates a PowerPoint template, embeds QR codes, converts slides to PDF, and produces a Markdown summary.
- It leverages multiprocessing for speed and requires PowerPoint (COM) on Windows for PPTX→PDF conversion.

##### File Structure
- Top-level files:
- main.py – entry point
- config.json – user-customizable settings
- data.csv – input data
- certificate_template.pptx – PPTX template
- certificates.md / certificates_pdf/ – outputs
- requirements.txt – dependencies
- LICENSE.md, README.md, .gitignore
- No sub-directories besides the output folders. Temporary dirs created at runtime: certificates_pptx/, qr_codes/.

##### Extract Key Components from README
- Config loader reads config.json
- Data loader reads CSV
- Placeholder replacer uses python-pptx or COM API to fill text
- QR code generator library creates images linking to profile_url
- Multiprocessing manager dispatches rows to worker processes
- Each worker:
a. Replaces placeholders in a PPTX copy
b. Inserts QR code image
c. Saves temporary PPTX
d. Invokes PowerPoint COM to export PDF
e. Deletes temp PPTX/QR code images
f. Emits an entry for certificates.md
- Final outputs: a directory of PDFs + a Markdown summary

##### Relationships and Data Flow
- Config feeds into Data Module and into Multiprocessing Manager
- Data Module streams rows into Multiprocessing Manager
- Manager fans out rows to Worker Processes in parallel
- Template Copier → Placeholder Engine → QR Generator → PPTX→PDF Converter → Cleanup → Summary Buffer

##### Architectural Patterns & Principles
- Pipeline/Filter pattern: data → template → QR → PDF → summary
- Parallelism: multiprocessing pool to maximize throughput
- Modularity: each step is a separate module/function
- Configurable: behavior driven by config.json, CSV schema, and PPTX placeholders

##### Technologies & Frameworks
- Python 3.7+
- Multiprocessing library
- python-pptx or COM via pywin32
- qrcode / Pillow libraries
- Markdown writer (built-in file I/O)
- CSV standard library or pandas (if used)
- Windows PowerPoint COM

##### Detail Without Overthinking
- Every component from config loader to cleanup
- Data flow, dependencies, and parallel execution paths

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Core Flow
    CLI["User & CLI\n(Python CLI)"]:::module
    Config["Configuration Module\n(parses config.json)"]:::module
    Data["Data Module\n(reads data.csv)"]:::module
    MPManager["Multiprocessing Manager\n(spawns workers)"]:::module
    PPTCOM["Microsoft PowerPoint\nCOM API"]:::external

    CLI -->|"invoke"| Config
    CLI -->|"invoke"| Data
    Config -->|"settings"| MPManager
    Data -->|"row data"| MPManager

    subgraph "Worker Process"    
        direction TB
        Copier["PPTX Template Copier\n(copy certificate_template.pptx)"]:::module
        Placeholder["Placeholder Replacement Engine\n(python-pptx/COM)"]:::module
        QRGen["QR Code Generator\n(qrcode lib)"]:::module
        TMPPPTX["Temp PPTX Dir\n(certificates_pptx/)"]:::temp
        QRTMP["Temp QR Code Dir\n(qr_codes/)"]:::temp
        Converter["PPTX→PDF Converter\n(via PowerPoint COM)"]:::module
        Cleanup["Cleanup Routine\n(delete temp files)"]:::module
        Summary["Summary Writer\n(buffer entry)"]:::module

        MPManager --> Copier
        Copier --> Placeholder
        Placeholder --> QRGen
        QRGen --> TMPPPTX
        TMPPPTX --> Converter
        Converter -->|"uses COM API"| PPTCOM
        Converter --> Cleanup
        Cleanup --> Summary
    end

    %% Outputs
    Summary --> PDFs
    Summary --> MD

    PDFs["PDF Output\ncertificates_pdf/"]:::output
    MD["Markdown Summary\ncertificates.md"]:::output

    %% Documentation & Dependencies
    REQ["requirements.txt"]:::docs
    README["README.md"]:::docs
    LICENSE["LICENSE.md"]:::docs
    GITIGNORE[".gitignore"]:::docs

    CLI -.-> REQ
    CLI -.-> README
    CLI -.-> LICENSE
    CLI -.-> GITIGNORE

    %% Click Events
    click CLI "https://github.com/sanskaromar/certifai/blob/main/main.py"
    click Config "https://github.com/sanskaromar/certifai/blob/main/config.json"
    click Data "https://github.com/sanskaromar/certifai/blob/main/data.csv"
    click MPManager "https://github.com/sanskaromar/certifai/blob/main/main.py"
    click Copier "https://github.com/sanskaromar/certifai/blob/main/certificate_template.pptx"
    click TMPPPTX "https://github.com/sanskaromar/certifai/tree/main/certificates_pptx/"
    click QRTMP "https://github.com/sanskaromar/certifai/tree/main/qr_codes/"
    click PDFs "https://github.com/sanskaromar/certifai/tree/main/certificates_pdf/"
    click MD "https://github.com/sanskaromar/certifai/blob/main/certificates.md"
    click REQ "https://github.com/sanskaromar/certifai/blob/main/requirements.txt"
    click README "https://github.com/sanskaromar/certifai/blob/main/README.md"
    click LICENSE "https://github.com/sanskaromar/certifai/blob/main/LICENSE.md"
    click GITIGNORE "https://github.com/sanskaromar/certifai/blob/main/.gitignore"

    %% Styles
    classDef module fill:#D0E8FF,stroke:#0366d6,stroke-width:1px;
    classDef external fill:#C8E6C9,stroke:#2E7D32,stroke-width:1px;
    classDef output fill:#FFE0B2,stroke:#EF6C00,stroke-width:1px;
    classDef temp fill:#F0F0F0,stroke:#888888,stroke-dasharray: 4 2;
    classDef docs fill:#F5F5F5,stroke:#616161,stroke-width:1px;
```
