Skip to main content

Simplifies interacting with Grafana, with a focus on templating dashboards

Project description

Test Status Codecov Maintainability Read the Docs

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.2.0

Changelog

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)

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

grafanarmadillo-0.2.0.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

grafanarmadillo-0.2.0-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file grafanarmadillo-0.2.0.tar.gz.

File metadata

  • Download URL: grafanarmadillo-0.2.0.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.10.12

File hashes

Hashes for grafanarmadillo-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a6de99476dce35b4ed38132f3e775ac83ae892cac0539a069793c697c7e0295b
MD5 94b2bf1fda814a4261388f3e756b7594
BLAKE2b-256 51ab62491526626cfa17b82f6b9d6b225cd8ff47eb06c306ab5a85d89b837ece

See more details on using hashes here.

File details

Details for the file grafanarmadillo-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: grafanarmadillo-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.10.12

File hashes

Hashes for grafanarmadillo-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 84b3474710c0d877cf1ca177273cf8c15dad2fa337db947923b1e2ff92be3cfa
MD5 199e17431ced87b844aa8f7df34b98a8
BLAKE2b-256 0023ff1c89e3ecceb79db143ddf9fe6d1ce75991f8931c278769fcc0a91eda86

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