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.7.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.7-py3-none-any.whl (159.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kb_dashboard_core-0.2.7.tar.gz
  • Upload date:
  • Size: 105.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kb_dashboard_core-0.2.7.tar.gz
Algorithm Hash digest
SHA256 64f4c72a1682dc0de0c4863eaaf34e82e8d75dba83b2523abd639d8dbe14347b
MD5 5102c31b48ebc11c4ad19ed59965417c
BLAKE2b-256 244a5eb225e700b460637e81b5a994c9cb5b0fd6d6c0bc23481d06cb992b8512

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kb_dashboard_core-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 159.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kb_dashboard_core-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 6e6048e31d52dc0b99891f354ac60a1cc7d9621aed4c1f5829765f3bb86e0ba5
MD5 2752b4517d1a72e074ea09ab0a20dd1d
BLAKE2b-256 bb168853e834d73525424c71ee8f647b1f032ebe43472899242756ffcd6f59b5

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