Add README.md

This commit is contained in:
Mika 2026-02-11 12:51:48 +00:00
parent c9f39d5107
commit b95d8b77ef

91
README.md Normal file
View file

@ -0,0 +1,91 @@
# Gate Analysis
## Überblick
Das Projekt **gate_analysis** dient der Analyse von Unknown-Fällen in CI-Prozessen. Ziel ist es, mittels Python-Skripten detaillierte statistische Auswertungen über Ursachen und Häufigkeiten dieser Fälle zu erstellen.
Link zum Artikel: [https://donau2space.de/tag-146-frauen-in-der-wissenschaft-und-mein-gate-v1-tag-1-unknowns-endlich-sauber-auseinandergezogen/](https://donau2space.de/tag-146-frauen-in-der-wissenschaft-und-mein-gate-v1-tag-1-unknowns-endlich-sauber-auseinandergezogen/)
Git Repository: [https://git.donau2space.de/Mika/gate_analysis](https://git.donau2space.de/Mika/gate_analysis)
### Hinweis
Alle Inhalte wurden per KI generiert. Nutzung, Anpassung und Weiterentwicklung erfolgen eigenverantwortlich und auf eigenes Risiko. Es wird keine Korrektheit, Sicherheit, Funktionsfähigkeit oder rechtliche Eignung zugesichert.
## Inhalt des Repositories
### 1. unknown_case_counter
- **Art:** python_script
- **Ziel:** mixed
- **Sprache:** Python
- **Zweck:** Liest `delta_cases.csv`, zählt Unknown-Fälle und sortiert sie nach Ursachen.
- **API-Funktion:**
- `count_unknown_reasons(file_path)` → Gibt ein Dictionary mit Ursachen und deren Häufigkeit zurück.
- **Datenstruktur:**
- `UnknownReasons` (JSON): Felder `reason`, `count`
### 2. unknown_whitelist_manager
- **Art:** python_script
- **Ziel:** mixed
- **Sprache:** Python
- **Zweck:** Verwaltung einer Whitelist für bekannte Unknown-Fälle.
- **API-Funktion:**
- `update_whitelist(whitelist_path, entry)` → Fügt Einträge zur Whitelist hinzu oder aktualisiert sie.
- **Datenstruktur:**
- `WhitelistEntry` (JSON): Feld `entry`
### 3. delta_cases_analyzer
- **Art:** doc_only
- **Ziel:** mixed
- **Sprache:**
- **Zweck:** Dokumentation zur Analyse von `delta_cases.csv` und zur Interpretation der Unknown-Fälle.
## Installation & Nutzung
### Voraussetzungen
- Python ≥ 3.8
- Zugriff auf ein CSV-Dataset mit Unknown-Fällen (z.B. `delta_cases.csv`)
### Installation
1. Repository klonen:
`git clone https://git.donau2space.de/Mika/gate_analysis`
2. In das Projektverzeichnis wechseln:
`cd gate_analysis`
3. Abhängigkeiten installieren (falls erforderlich):
`pip install -r requirements.txt`
### Nutzung
#### Unknown Case Counter
```
python unknown_case_counter.py --file delta_cases.csv
```
#### Whitelist Manager
```
python unknown_whitelist_manager.py --whitelist whitelist.json --add "NewUnknownReason"
```
## Typische Use-Cases
- Statistische Auswertung von Unknown-Fällen in CI-Pipelines
- Erstellung einer Ursachenanalyse auf Basis von CSV-Daten
- Pflege einer Whitelist, um bekannte Unknowns aus der Statistik auszublenden
- Dokumentierte Beurteilung der Unknown-Fälle für Qualitätsberichte
## Struktur & mögliche Erweiterungen
**Struktur:**
- `unknown_case_counter.py` — Zähl- und Analysefunktionen
- `unknown_whitelist_manager.py` — Verwaltung von Whitelist-Einträgen
- `docs/delta_cases_analyzer.md` — Methodische Beschreibung der Analyseverfahren
**Erweiterungen:**
- Integration in CI-Reporting-Frameworks
- Export nach JSON oder Datenbanken
- Automatische Erkennung neuer Unknown-Muster
## Lizenz
Lizenz: **MIT**
Der gesamte Inhalt wurde automatisiert durch KI erstellt. Nutzung und Weiterentwicklung erfolgen auf eigene Verantwortung.