Skip to main content

Core compilation engine for YAML to Kibana dashboard format

Project description

kb-dashboard-core

Core compilation engine for YAML to Kibana dashboard format.

Overview

kb-dashboard-core is a pure Python library that provides the core compilation functionality for converting YAML dashboard definitions to Kibana's JSON format. This package contains no external service dependencies (no Elasticsearch, Kibana HTTP client, CLI framework, or LSP dependencies).

Features

  • Load dashboard configurations from YAML files
  • Compile YAML dashboard definitions to Kibana JSON format
  • Support for various panel types (Lens charts, markdown, etc.)
  • Control and filter compilation
  • Query building and validation

Installation

pip install kb-dashboard-core

Usage

from kb_dashboard_core import load, render, dump

# Load dashboards from YAML
dashboards = load('path/to/dashboard.yaml')

# Render to Kibana format
for dashboard in dashboards:
    kibana_json = render(dashboard)
    print(kibana_json.model_dump_json(indent=2))

# Save dashboards back to YAML
dump(dashboards, 'path/to/output.yaml')

Development

See DEVELOPING.md for development setup and workflows.

License

MIT

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

kb_dashboard_core-0.2.0.tar.gz (105.3 kB view details)

Uploaded Source

Built Distribution

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

kb_dashboard_core-0.2.0-py3-none-any.whl (159.8 kB view details)

Uploaded Python 3

File details

Details for the file kb_dashboard_core-0.2.0.tar.gz.

File metadata

  • Download URL: kb_dashboard_core-0.2.0.tar.gz
  • Upload date:
  • Size: 105.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.2

File hashes

Hashes for kb_dashboard_core-0.2.0.tar.gz
Algorithm Hash digest
SHA256 24eae35f9a2c8bf22e8c61695a1b515af6e79f5b639a6a52c7f95ea70c98b67a
MD5 5f7c37f0a8eede9611343e6b46403173
BLAKE2b-256 7aa5cf2e8f2de312e175127fece65ed2eeb56925b9c931a8584bd4facc8efc3b

See more details on using hashes here.

File details

Details for the file kb_dashboard_core-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for kb_dashboard_core-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 44a857bbc895752e37a33309309afff4da03739cd980121a58346150a32fbfa2
MD5 c652be647f7d7454bba529dc293f9006
BLAKE2b-256 945f49f771a5d2b24445330bc7c98735da67f60845d9417951e5a62b8f0b5e7d

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