Simplifies interacting with Grafana, with a focus on templating dashboards
Project description
Summary
Grafanarmadillo simplifies interacting with Grafana, with a focus on templating dashboards.
Library
Grafanarmadillo is a library that navigates the Grafana API. It has helpers to find dashboards and alerts; make and fill templates; and provision those filled templates. See https://github.com/lilatomic/grafanarmadillo/tree/main/docs/rst/usage.rst for samples.
Tools
Grafanarmadillo is a tool that helps turn dashboards and alerts into templates and to turn templates into dashboards and alerts. See https://github.com/lilatomic/grafanarmadillo/tree/main/docs/rst/cli.rst
Acknowledgments
This repository was built from the skeleton developed by Joao M. C. Teixeira (webpage, github)
Version
v0.6.0
Changelog
v0.6.0 (2024-03-23)
feature : expose functions to resolve path-like objects into their Grafana references
fix : handle folders and dashboards with non-path-safe elements
task : migrate from tox to Pants for build system
v0.5.0 (2024-02-25)
feature : bulk migrator supports templating
v0.4.0 (2024-02-13)
feature : migrator to upgrade alerts from Legacy to Unified
feature : bulk migrator to move all alerts and dashboards
v0.3.0 (2023-12-26)
feature : Finder.create_or_get_alert will create a placeholder alert instead of faking one
feature : helpful Flow for performing multiple templating operations
feature : can set provenance of provisioned alerts (defaults to disabled)
deprecated : Windows and MacOS platforms are no longer supported
v0.2.1 (2023-10-31)
feature : option to automatically generate template replacers in cli
feature : expose cli functions as library functions
v0.2.0 (2023-10-30)
feature : find, template, import, and export alerts
feature : helpful CLI to do the most common task
feature : add Python 3.12 support
deprecated : drop Python 3.7 support
v0.1.0 (2023-08-09)
feature : add Python 3.11 support
feature : add Grafana 9 and 10 support
task : switch backend to panodata/grafana-client
v0.0.9 (2022-07-26)
feature : add Python 3.9 and Python 3.10 support
v0.0.8 (2021-09-26)
feature : add Finder.create_or_get_dashboard to help importing dashboards
feature : add helper DashboardTransformer to combine several DashboardTransformers
feature : add helper DashboardTransformer to process all panels in a dashboard
v0.0.7 (2021-09-24)
feature : Templator, which makes templates from dashboards (and vice-versa) by applying arbitrary transforms
includes a helper to easily convert a dictionary into a list of terms to globally find/replace
v0.0.6 (2021-09-21)
feature : Dashboarder
can get or set the content of a dashboard
can export and import dashboards (like with the “json model” and “import” buttons in Grafana)
patch : get_dashboard returns exactly 1 (not a list)
patch : get_folder returns exactly 1 (not list)
patch : fix returns of methods in Finder
v0.0.5 (2021-09-20)
fix build
v0.0.4 (2021-09-20)
docsdocsdocs
v0.0.3 (2021-09-20)
adds methods for finding Grafana dashboards and folders by name
v0.0.2 (2021-09-18)
fixes CICD pipelines
v0.0.1 (2021-09-16)
templates from https://github.com/joaomcteixeira/python-project-skeleton
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for grafanarmadillo-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 818b8126706edab744a21434471530d66b8b5f5fe17046a8127736a8d7745db5 |
|
MD5 | 59a71a4dde964acc399861b7ab0d3814 |
|
BLAKE2b-256 | 07b73b0a5434d840aaa7a485da59a3ed99c1d4068e320d54abed62da837c5f02 |