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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kb_dashboard_core-0.2.4.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.4.tar.gz
Algorithm Hash digest
SHA256 5129e8116db0242766e735b2d91038a7724a9c508f4050bceb1a4de5793b5066
MD5 5e181ce911d4b90a1f87cb579cbfc66c
BLAKE2b-256 4eae7cf0f1e3d6e006a2eda91a51f9f488c65ab0b917813f55fadbdb556e2e8b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kb_dashboard_core-0.2.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d4902579da98929858da0eba53de97e271e4a0c30d5eedd477ce1070b7f792d3
MD5 cf07b9d201d7e741cf479ee53a7a682b
BLAKE2b-256 e6f35b22a1312eacfe8d3dd15e554de92202db1b105fa60d608535660f4f2ec0

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