# akhilannan/pbir-utils architecture

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

- Interactive diagram: https://gitdiagram.com/akhilannan/pbir-utils
- Repository: https://github.com/akhilannan/pbir-utils

## Overview

##### Main System Components

a) Interface Layer:
- Entry point through the main package interface (pbir_utils)
- How users interact with the library through Python imports

b) Core Processing Layer:
- Central component should be the PBIR Processor (pbir_processor.py)
- Metadata Extractor (metadata_extractor.py)
- Report Sanitizer (pbir_report_sanitizer.py)

c) Utility Layer:
- Specialized utilities (filter_utils.py, json_utils.py, etc.)
- Visualization components (report_wireframe_visualizer.py)

##### Component Relationships

a) Primary Flow:
- User Code → PBIR Utils Interface → Core Processors → Utility Modules

b) Data Flow:
- Input: PBIR Files → Metadata Extractor
- Processing: Core Processors ↔ Utility Modules
- Output: Processed PBIR Files / Visualizations

##### Specific Components

**Core Processing Components:**
- PBIR Processor
- Metadata Extractor
- Report Sanitizer

**Utility Components:**
- Filter Utils
- JSON Utils
- Measure Utils
- Visual Interactions Utils

**Visualization Components:**
- Report Wireframe Visualizer

##### Additional Elements

Supporting elements:

- Input/Output formats (PBIR files)
- External dependencies (if any)
- Version control integration (.github/workflows)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles and Classes
    classDef core fill:#b3d1ff,stroke:#4d88ff
    classDef utility fill:#b3ffb3,stroke:#4d994d
    classDef io fill:#ffcc99,stroke:#ff9933
    classDef viz fill:#e6b3ff,stroke:#9933ff
    classDef interface fill:#f2f2f2,stroke:#666666

    %% Legend
    subgraph Legend
        L1[Core Component]:::core
        L2[Utility Module]:::utility
        L3[I/O Operation]:::io
        L4[Visualization]:::viz
        L5[Interface]:::interface
    end

    %% Interface Layer
    subgraph Interface
        MainInterface["PBIR Utils Interface"]
        ExampleUsage["Example Usage"]
        PackageConfig["Package Config"]
        Deployment["Deployment Workflow"]
    end

    %% Core Processing Layer
    subgraph Core
        PBIRProcessor["PBIR Processor"]
        MetadataExtractor["Metadata Extractor"]
        ReportSanitizer["Report Sanitizer"]
    end

    %% Utility Layer
    subgraph Utils
        FilterUtils["Filter Utils"]
        JSONUtils["JSON Utils"]
        MeasureUtils["Measure Utils"]
        VisualInteractions["Visual Interactions Utils"]
    end

    %% Visualization Layer
    subgraph Visualization
        WireframeViz["Report Wireframe Visualizer"]
    end

    %% I/O Operations
    InputPBIR[("Input PBIR Files")]:::io
    OutputPBIR[("Processed PBIR Files")]:::io

    %% Relationships
    InputPBIR --> MainInterface
    MainInterface --> PBIRProcessor
    MainInterface --> MetadataExtractor
    MainInterface --> ReportSanitizer

    PBIRProcessor <--> MetadataExtractor
    PBIRProcessor <--> ReportSanitizer
    
    PBIRProcessor --> FilterUtils
    PBIRProcessor --> JSONUtils
    PBIRProcessor --> MeasureUtils
    PBIRProcessor --> VisualInteractions
    
    MetadataExtractor --> WireframeViz
    ReportSanitizer --> OutputPBIR

    ExampleUsage -.-> MainInterface
    PackageConfig -.-> MainInterface
    Deployment -.-> MainInterface

    %% Styling
    class PBIRProcessor,MetadataExtractor,ReportSanitizer core
    class FilterUtils,JSONUtils,MeasureUtils,VisualInteractions utility
    class WireframeViz viz
    class MainInterface,ExampleUsage,PackageConfig,Deployment interface

    %% Click Events
    click MainInterface "https://github.com/akhilannan/pbir-utils/blob/main/src/pbir_utils/__init__.py"
    click PBIRProcessor "https://github.com/akhilannan/pbir-utils/blob/main/src/pbir_utils/pbir_processor.py"
    click MetadataExtractor "https://github.com/akhilannan/pbir-utils/blob/main/src/pbir_utils/metadata_extractor.py"
    click ReportSanitizer "https://github.com/akhilannan/pbir-utils/blob/main/src/pbir_utils/pbir_report_sanitizer.py"
    click FilterUtils "https://github.com/akhilannan/pbir-utils/blob/main/src/pbir_utils/filter_utils.py"
    click JSONUtils "https://github.com/akhilannan/pbir-utils/blob/main/src/pbir_utils/json_utils.py"
    click MeasureUtils "https://github.com/akhilannan/pbir-utils/blob/main/src/pbir_utils/pbir_measure_utils.py"
    click VisualInteractions "https://github.com/akhilannan/pbir-utils/blob/main/src/pbir_utils/visual_interactions_utils.py"
    click WireframeViz "https://github.com/akhilannan/pbir-utils/blob/main/src/pbir_utils/report_wireframe_visualizer.py"
    click ExampleUsage "https://github.com/akhilannan/pbir-utils/blob/main/examples/example_usage.ipynb"
    click PackageConfig "https://github.com/akhilannan/pbir-utils/blob/main/pyproject.toml"
    click Deployment "https://github.com/akhilannan/pbir-utils/blob/main/.github/workflows/python-publish.yml"
```
