# alilacream/public_charikat architecture

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

- Interactive diagram: https://gitdiagram.com/alilacream/public_charikat
- Repository: https://github.com/alilacream/public_charikat

## Overview

Charikat is a static collection of Moroccan enterprise data in JSON, intended for people and developers to use. The documented workflow is to use the data directly or run the built-in converter to produce an Excel spreadsheet; the converter reads the repository’s JSON file and writes an output workbook. The source excerpts show this conversion directly. Other advertised tools, such as search or an API, are future ideas rather than implemented components.

Main entry points: [`src/public_charikat/convert/excel.py`](https://github.com/alilacream/public_charikat/blob/main/src/public_charikat/convert/excel.py) (Excel converter), [`charikat.json`](https://github.com/alilacream/public_charikat/blob/main/charikat.json) (Enterprise data)

## Diagram (Mermaid)

```mermaid
flowchart TD

node_user(("User"))
node_data["Enterprise data<br/>[charikat.json]"]
node_converter["Excel converter<br/>[excel.py]"]
node_workbook["Excel workbook"]

node_user -->|"uses directly"| node_data
node_user -->|"runs"| node_converter
node_converter -->|"reads"| node_data
node_converter -->|"writes"| node_workbook

click node_data "https://github.com/alilacream/public_charikat/blob/main/charikat.json"
click node_converter "https://github.com/alilacream/public_charikat/blob/main/src/public_charikat/convert/excel.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_user toneBlue
class node_data,node_converter toneTeal
class node_workbook toneIndigo
```

## Components

### Other components

- **User**
- [Enterprise data](https://github.com/alilacream/public_charikat/blob/main/charikat.json): `charikat.json`
- [Excel converter](https://github.com/alilacream/public_charikat/blob/main/src/public_charikat/convert/excel.py): `src/public_charikat/convert/excel.py`
- **Excel workbook**

## Connections

- User → Enterprise data: uses directly (evidence: `README.md`)
- User → Excel converter: runs (evidence: `README.md`)
- Excel converter → Enterprise data: reads (evidence: `src/public_charikat/convert/excel.py`)
- Excel converter → Excel workbook: writes (evidence: `src/public_charikat/convert/excel.py`)
