Skip to main content

Work with OParl Papers (and it's related types).

Project description

🏛️ KRAken - Stadt Bonn Ratsinfo

Kommunaler Recherche-Assistent für die Verarbeitung von Ratsinformationen der Stadt Bonn 🔍

📋 Beschreibung

KRAken ist ein Python-Projekt zur intelligenten Verarbeitung und Analyse von kommunalen Ratsinformationen aus der Stadt Bonn. Das Tool bietet eine vollständige Pipeline von der Datenextraktion über die KI-gestützte Analyse bis hin zur Bereitstellung über verschiedene APIs.

✨ Hauptfunktionen

  • 📥 Download: Automatischer Abruf von Ratsdokumenten über die OParl-API
  • 🔄 Konvertierung: Umwandlung von PDF-Dokumenten in maschinenlesbare Formate
  • 🤖 KI-Analyse: Intelligente Klassifikation und Zusammenfassung mit LLMs
  • 🔍 Vektorsuche: Semantische Suche in dokumentierten Inhalten
  • 🌐 API-Server: FastAPI-basierte Schnittstelle für externe Anwendungen
  • 📊 Datenexploration: Jupyter-Notebooks für interaktive Analysen

🚀 Installation

uv installieren

Zunächst muss uv installiert werden, da es in diesem Projekt verwendet wird.

Installationsanweisungen finden Sie in der uv Dokumentation.

Falls Sie bereits eine ältere Version von uv installiert haben, aktualisieren Sie mit uv self update.

# Abhängigkeiten installieren
uv install

# Entwicklungsabhängigkeiten installieren
uv sync --group dev

💻 Nutzung

📥 Daten herunterladen und verarbeiten

# Ratspapiere herunterladen (begrenzt für Tests)
uv run oparl download paper --data-path data/ --max-pages 1

# Heruntergeladene Dokumente konvertieren
uv run oparl convert paper --data-path data/ --all

# Einzelnes Dokument klassifizieren
uv run oparl classify --data-path data/pfad/zum/dokument.md

🏛️ Sitzungsinformationen abrufen

Das meeting get Kommando ermöglicht den schnellen Zugriff auf detaillierte Informationen zu Ratssitzungen. Es eignet sich besonders für:

  • 📋 Sitzungsübersicht: Schnelle Orientierung über Termine, Status und Tagesordnung
  • 🔍 Themenfindung: Identifikation relevanter Beratungsgegenstände
  • 📄 Dokumentenzugriff: Automatischer Download von Einladungen und Protokollen
  • 👥 Teilnehmeranalyse: Überblick über beteiligte Personen und ihre Rollen
  • 🔗 Vernetzung: Verknüpfung zu zugehörigen Drucksachen und Anträgen
# Kompakte Übersicht (Standard) - zeigt nur wichtige Themen
uv run oparl meeting get --data-path meetings-test --meeting-id 2004507

# Mit Teilnehmer-Liste
uv run oparl meeting get --data-path meetings-test --meeting-id 2004507 --show-participants

# Vollständige Details aller Tagesordnungspunkte
uv run oparl meeting get --data-path meetings-test --meeting-id 2004507 --detailed

# Ohne automatischen Download von Dokumenten
uv run oparl meeting get --data-path meetings-test --meeting-id 2004507 --no-download-files

🔧 Filteroptionen

Die Filter können mit uv run oparl filter verwendet werden:

# Bestimmte Attribute aus analysis.json-Dateien extrahieren
uv run oparl filter analysis --data-path data-100-haiku --attributes summary tags

Die Attribute title und date sind immer in der Ausgabe enthalten.

🌐 Server starten

MCP Server (Model Context Protocol)

uv run fastmcp run src/stadt_bonn_oparl/mcp/server.py --transport sse

FastAPI Server

uv run fastapi run src/stadt_bonn_oparl/api/server.py --port 8000

🔍 Topic Scout testen

uv run scripts/test_topic_scout.py

🧪 Testing und Code-Qualität

# Tests ausführen
uv run pytest

# Tests mit Coverage
uv run pytest --cov

# Linting
uv run ruff check

# Code formatieren
uv run ruff format

# Typenprüfung
uv run mypy src/

Datenexploration 📊

Im Notebook explore analysis finden Sie eine erste Analyse der Daten. Für eine umfassendere Datenexploration können Sie auch das Dataset auf Kaggle nutzen: Stadt Bonn Allris Partial. Hier werden verschiedene Aspekte der Daten untersucht, um ein besseres Verständnis für die Struktur und den Inhalt der Ratsinformationen zu gewinnen.

Rechtliches

Die Daten stammen von der Stadt Bonn und unterliegen den jeweiligen Lizenzbedingungen. Bitte beachten Sie die Lizenzbedingungen, bevor Sie die Daten verwenden oder weitergeben. Die Dateien in diesem Repository unterliegen der GPL-3.0-Lizenz. Weitere Informationen finden Sie in der Datei LICENSE.


Dieses Projekt fördert transparente, nachvollziehbare und partizipative Konsensbildung. Für Fragen oder Beiträge bitte die verlinkten Dokumente als Ausgangspunkt nutzen.

Mach!Den!Staat! ❤️ Open Source AI

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stadt_bonn_oparl-1.8.2.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stadt_bonn_oparl-1.8.2-py3-none-any.whl (125.6 kB view details)

Uploaded Python 3

File details

Details for the file stadt_bonn_oparl-1.8.2.tar.gz.

File metadata

  • Download URL: stadt_bonn_oparl-1.8.2.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.8

File hashes

Hashes for stadt_bonn_oparl-1.8.2.tar.gz
Algorithm Hash digest
SHA256 27a65497307e35b01a04b40ab20fb07aad87a763684550005b49bb9f6ab2640c
MD5 6ba051df8ca747d1b2a9df7c7ee1cf90
BLAKE2b-256 361690fc58f55fd5e76bd2957f419326bc89c7e311a767cb3616b62f354fef14

See more details on using hashes here.

File details

Details for the file stadt_bonn_oparl-1.8.2-py3-none-any.whl.

File metadata

File hashes

Hashes for stadt_bonn_oparl-1.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3263bd2a7b3d252e703863d799f1be6d2d966ed9ea356a96550d0c96b4166c55
MD5 5b130aa09ba0253f2f55ae000e0fce67
BLAKE2b-256 cf0cd521edf01a04e9ff4a95d9c938d40fa4d810b94c09649369de2c0a34c40e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page