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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kb_dashboard_core-0.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 54e89d30a7569c12777943e05b1a55f85ae677fcfc04417a548ff2d4c62197df
MD5 67684c5ed358781fc3b3ad1a6e74e8d1
BLAKE2b-256 eafe31955d002d1433322bc3b969f4291e677ce47b635161ea2458801e59994d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kb_dashboard_core-0.2.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d8db72c64cb3f16722e0c964130cdb028f28e803ecc482b0f0978ff83f723bf5
MD5 0ede28a7caacd320750729414c3fc204
BLAKE2b-256 21d5b879cf780e35b4693df18524c319a4db345d26702f8028624f2f8d51539e

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