# svalgaard/fskintra architecture

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

- Interactive diagram: https://gitdiagram.com/svalgaard/fskintra
- Repository: https://github.com/svalgaard/fskintra

## Overview

##### Project type and purpose
- This is a standalone Python CLI tool (“fskintra”) that logs into the Danish ForældreIntra (School-Parent portal) web service, scrapes various sections (e.g., contacts, documents, homework), converts that content into standard email messages, and dispatches them via SMTP. It is intended to run on demand or as a scheduled job (cron/Docker).

##### File structure
- Top-level files:
- fskintra.py – the CLI entry point
- requirements.txt – Python dependencies
- Dockerfile – container build instructions
- docs/ – documentation source (Jekyll site)
- Python package “skoleintra/”:
- config.py – loads credentials and settings
- surllib.py – HTTP session & authentication wrapper
- sbs4.py – HTML parsing helpers (BeautifulSoup4)
- semail.py – email message construction & SMTP delivery
- snotifications.py – notification/logging logic
- schildren.py – child‐specific data handling
- pg*.py modules – page‐specific scrapers (pgContacts, pgDocuments, pgHomework, etc.)

##### README for additional insights
- Purpose: unofficial third-party tool, convert portal content to email
- Deployment: can be installed via pip, executed manually or in cron, can run inside Docker

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Runtime Environment
    subgraph "Runtime / Scheduler"
        Scheduler["Scheduler / Runtime (cron / Docker)"]:::runtime
    end

    %% Internal Python Package
    subgraph "skoleintra package"
        CLI["CLI: fskintra.py"]:::internal
        Config["Config Loader\n(config.py)"]:::internal
        HTTP["HTTP Client & Auth\n(surllib.py)"]:::internal
        Parser["HTML Parser\n(sbs4.py)"]:::internal
        Child["Child Data Handler\n(schildren.py)"]:::internal
        Email["Email Builder & Dispatcher\n(semail.py)"]:::internal
        Logger["Logger / Notifications\n(snotifications.py)"]:::internal

        subgraph "Page-specific Scrapers"
            pgContacts["pgContacts"]:::internal
            pgDocuments["pgDocuments"]:::internal
            pgHomework["pgHomework"]:::internal
            pgWeekplans["pgWeekplans"]:::internal
            pgFrontpage["pgFrontpage"]:::internal
            pgDialogue["pgDialogue"]:::internal
            pgConfirm["pgConfirm"]:::internal
            pgPhotos["pgPhotos"]:::internal
            pgSignup["pgSignup"]:::internal
        end
    end

    %% External Services
    ForældreIntra["ForældreIntra Web Service"]:::external
    SMTP["SMTP Server"]:::external

    %% Data Flow
    Scheduler -->|"triggers"| CLI
    CLI -->|"load credentials"| Config
    Config -->|"settings & URL"| HTTP
    HTTP -->|"fetch HTML"| pgContacts
    HTTP -->|"fetch HTML"| pgDocuments
    HTTP -->|"fetch HTML"| pgHomework
    HTTP -->|"fetch HTML"| pgWeekplans
    HTTP -->|"fetch HTML"| pgFrontpage
    HTTP -->|"fetch HTML"| pgDialogue
    HTTP -->|"fetch HTML"| pgConfirm
    HTTP -->|"fetch HTML"| pgPhotos
    HTTP -->|"fetch HTML"| pgSignup

    pgContacts -->|"raw HTML"| Parser
    pgDocuments -->|"raw HTML"| Parser
    pgHomework -->|"raw HTML"| Parser
    pgWeekplans -->|"raw HTML"| Parser
    pgFrontpage -->|"raw HTML"| Parser
    pgDialogue -->|"raw HTML"| Parser
    pgConfirm -->|"raw HTML"| Parser
    pgPhotos -->|"raw HTML"| Parser
    pgSignup -->|"raw HTML"| Parser

    Parser -->|"parsed data"| Child
    Child -->|"child-structured data"| Email
    Email -->|"MIME message"| SMTP

    %% Error and Notification Flows
    HTTP -->|error| Logger
    Parser -->|error| Logger
    Email -->|delivery status| Logger

    %% External Integration
    HTTP -->|login & requests| ForældreIntra
    Email -->|SMTP session| SMTP

    %% Click Events
    click CLI "https://github.com/svalgaard/fskintra/blob/master/fskintra.py"
    click Config "https://github.com/svalgaard/fskintra/blob/master/skoleintra/config.py"
    click HTTP "https://github.com/svalgaard/fskintra/blob/master/skoleintra/surllib.py"
    click Parser "https://github.com/svalgaard/fskintra/blob/master/skoleintra/sbs4.py"
    click pgContacts "https://github.com/svalgaard/fskintra/blob/master/skoleintra/pgContacts.py"
    click pgDocuments "https://github.com/svalgaard/fskintra/blob/master/skoleintra/pgDocuments.py"
    click pgHomework "https://github.com/svalgaard/fskintra/blob/master/skoleintra/pgHomework.py"
    click pgWeekplans "https://github.com/svalgaard/fskintra/blob/master/skoleintra/pgWeekplans.py"
    click pgFrontpage "https://github.com/svalgaard/fskintra/blob/master/skoleintra/pgFrontpage.py"
    click pgDialogue "https://github.com/svalgaard/fskintra/blob/master/skoleintra/pgDialogue.py"
    click pgConfirm "https://github.com/svalgaard/fskintra/blob/master/skoleintra/pgConfirm.py"
    click pgPhotos "https://github.com/svalgaard/fskintra/blob/master/skoleintra/pgPhotos.py"
    click pgSignup "https://github.com/svalgaard/fskintra/blob/master/skoleintra/pgSignup.py"
    click Child "https://github.com/svalgaard/fskintra/blob/master/skoleintra/schildren.py"
    click Email "https://github.com/svalgaard/fskintra/blob/master/skoleintra/semail.py"
    click Logger "https://github.com/svalgaard/fskintra/blob/master/skoleintra/snotifications.py"
    click Scheduler "https://github.com/svalgaard/fskintra/tree/master/Dockerfile"
    click Scheduler "https://github.com/svalgaard/fskintra/blob/master/docs/cron.md"
    click Scheduler "https://github.com/svalgaard/fskintra/blob/master/docs/assets/run-cron-example.sh"

    %% Styles
    classDef internal fill:#B3E5FC,stroke:#0288D1,color:#000;
    classDef external fill:#C8E6C9,stroke:#2E7D32,color:#000;
    classDef runtime fill:#FFF9C4,stroke:#F9A825,color:#000;
```
