# rybinsky/prkt architecture

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

- Interactive diagram: https://gitdiagram.com/rybinsky/prkt
- Repository: https://github.com/rybinsky/prkt

## Overview

##### Project type and purpose
- This is a Python-based open-source tool (“prkt”) for detecting and analyzing parking spaces from a video or camera feed using a YOLOv4-tiny object-detection model.

##### File structure
- Top-level:
- .gitignore, .pre-commit-config.yaml, README.md, pyproject.toml (packaging and linting)
- prkt/README.md (project docs)
- Python package “prkt/prkt”:
- main.py          — entry point and orchestrator
- config/config.yaml + config loader (implicit in utils or config)
- camera.py        — abstraction for video or camera inputs
- detector.py      — wraps YOLO inference logic
- parking_space.py — logic for defining/managing individual parking slots
- utils.py         — shared helpers (logging, image‐processing routines)
- yolo/            — model definition (cfg, weights)
- prkt/tests: skeleton for unit tests

1. Configuration Manager
- Reads config.yaml (paths, thresholds, camera parameters)
2. Camera Input Module
- Captures frames (USB cam, RTSP, video file)
3. YOLO Detector
- Loads yolov4-tiny.cfg & weights
- Runs inference on each frame
- Applies NMS, filters detections
5. Parking-Space Logic
- Maps detections to predefined parking-slot regions
- Determines occupancy state
6. Utilities
- Logging, drawing functions, any file I/O
7. Orchestrator (main.py)
- Glues everything: loads config, instantiates modules, loops over frames, outputs results

b. Data flows and dependencies
- Start → main.py
- main loads Configuration Manager → provides parameters to Camera and Detector
- Camera Module → Frame (raw image) → Detector
- Parking-Space Logic → Occupancy status → Output (console/log/video overlay)

c. Architectural patterns & design principles
- Modular, single-responsibility modules for each major function
- Config-driven behavior: parameters decoupled from code
- Test harness under tests/ for maintainability

d. Key technologies & libraries
- Python 3.x
- OpenCV (cv2) or similar for image I/O
- Darknet Python bindings or PyTorch integration for YOLOv4-tiny
- PyYAML for config parsing
- pytest or unittest for tests

##### Essential elements to capture
- Configuration loading before runtime
- Model loading (cfg + weights)
- Frame capture loop
- Processing pipeline stages
- Final output mechanism (console log, overlay window, file)
- Test suite location (to show maintainability focus)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Configuration and Data Artifacts
    subgraph "Configuration"
        CM["Configuration Manager"]:::io
        CFG["config.yaml"]:::data
    end

    subgraph "Model Files"
        CFGF["yolov4-tiny.cfg"]:::data
        WTS["yolov4-tiny.weights"]:::data
    end

    %% Core Processing Pipeline
    subgraph "Processing Pipeline"
        Camera["Camera Input Module"]:::io
        Detector["YOLO Detector"]:::processing
        BBox["Bounding-Box Processor"]:::processing
        PSpace["Parking-Space Logic"]:::processing
    end

    %% Orchestration & Utilities
    subgraph "Orchestration & Utilities"
        Main["Orchestrator (main.py)"]:::orchestration
        Utils["Utilities"]:::orchestration
    end

    %% External Dependencies
    subgraph "External Dependencies"
        OC["OpenCV / cv2"]:::external
        DN["Darknet / PyTorch"]:::external
        YAML["PyYAML"]:::external
    end

    %% Test Suite
    Tests["Test Suite"]:::orchestration

    %% Data Flow
    Main -->|"load config"| CM
    CM -->|reads| CFG
    CM -->|provides params to| Camera
    CM -->|provides params to| Detector

    Main -->|init camera| Camera
    Main -->|init detector| Detector
    Main -->|uses| Utils

    Camera -->|"Frame"| Detector
    Detector -->|"Raw Predictions"| BBox
    BBox -->|"Filtered Boxes"| PSpace
    PSpace -->|"Occupancy Status"| Utils
    Utils -->|output overlay/log| Main

    Detector -->|loads model files| CFGF
    Detector -->|loads model files| WTS

    Camera -->|uses| OC
    Detector -->|uses| DN
    CM -->|uses| YAML

    Main -->|tests| Tests

    %% Click Events
    click CM "https://github.com/rybinsky/prkt/blob/main/prkt/prkt/config/config.yaml"
    click Camera "https://github.com/rybinsky/prkt/blob/main/prkt/prkt/camera.py"
    click Detector "https://github.com/rybinsky/prkt/blob/main/prkt/prkt/detector.py"
    click CFGF "https://github.com/rybinsky/prkt/blob/main/prkt/prkt/yolo/yolov4-tiny.cfg"
    click WTS "https://github.com/rybinsky/prkt/blob/main/prkt/prkt/yolo/yolov4-tiny.weights"
    click BBox "https://github.com/rybinsky/prkt/blob/main/prkt/prkt/bbox.py"
    click PSpace "https://github.com/rybinsky/prkt/blob/main/prkt/prkt/parking_space.py"
    click Utils "https://github.com/rybinsky/prkt/blob/main/prkt/prkt/utils.py"
    click Main "https://github.com/rybinsky/prkt/blob/main/prkt/prkt/main.py"
    click Tests "https://github.com/rybinsky/prkt/blob/main/prkt/tests/__init__.py"

    %% Styles
    classDef io fill:#D0E6FF,stroke:#1E90FF,color:#000
    classDef data fill:#E0F7FA,stroke:#00ACC1,color:#000
    classDef processing fill:#E6F4EA,stroke:#2E7D32,color:#000
    classDef orchestration fill:#F5F5F5,stroke:#9E9E9E,color:#000
    classDef external fill:#FFF3E0,stroke:#FB8C00,color:#000
```
