Metadata-Version: 2.1
Name: grafanarmadillo
Version: 0.2.0
Summary: Simplifies interacting with Grafana, with a focus on templating dashboards 
Home-page: https://github.com/lilatomic/grafanarmadillo
Author: lilatomic
License: MIT License
Project-URL: webpage, https://github.com/lilatomic/grafanarmadillo
Project-URL: Documentation, https://grafanarmadillo.readthedocs.io/en/latest/
Project-URL: Changelog, https://github.com/lilatomic/grafanarmadillo/blob/main/docs/CHANGELOG.rst
Project-URL: Issue Tracker, https://github.com/lilatomic/grafanarmadillo/issues
Project-URL: Discussion Forum, https://github.com/lilatomic/grafanarmadillo/discussions
Platform: UNKNOWN
Requires-Python: >=3.8, <4
Description-Content-Type: text/x-rst
Provides-Extra: cli
License-File: LICENSE

===============
Grafanarmadillo
===============

.. image:: https://github.com/lilatomic/grafanarmadillo/workflows/Tests/badge.svg?branch=main
    :target: https://github.com/lilatomic/grafanarmadillo/actions?workflow=Tests
    :alt: Test Status

.. image:: https://codecov.io/gh/lilatomic/grafanarmadillo/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/lilatomic/grafanarmadillo
    :alt: Codecov

.. image:: https://api.codeclimate.com/v1/badges/d96cc9a1841a819cd4f5/maintainability
   :target: https://codeclimate.com/github/lilatomic/grafanarmadillo/maintainability
   :alt: Maintainability

.. image:: https://img.shields.io/readthedocs/grafanarmadillo/latest?label=Read%20the%20Docs
    :target: https://grafanarmadillo.readthedocs.io/en/latest/index.html
    :alt: 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 <https://github.com/joaomcteixeira/python-project-skeleton>`_ developed by Joao M. C. Teixeira (`webpage <https://bit.ly/joaomcteixeira>`_, `github <https://github.com/joaomcteixeira>`_)

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)
-------------------

* templates from https://github.com/joaomcteixeira/python-project-skeleton


