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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kb_dashboard_core-0.2.3.tar.gz
  • Upload date:
  • Size: 105.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","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.3.tar.gz
Algorithm Hash digest
SHA256 07e1be6ad6e630499aa8edbf12203b35d55230cad02fb44494516e26eb6cf930
MD5 56b227f18b8627e20543c8614c792fe1
BLAKE2b-256 14691b12c79b769117ea366d6aba6eb57d7defc4fc514511eccb1aa3de47cf49

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kb_dashboard_core-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 159.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4281a437ec9f3e6551c8e331379127783f9b8e812dc6107c880fe2c775eac9dd
MD5 cfc6b7372bc862011fa5e779b115105d
BLAKE2b-256 523c4d6e35a39a372c8c351975fa9b0cff63e423691a5d7e45d6c397a3b8f816

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