Yet another Python library for Grafana API
Project description
grafana_api
![Codecov](https://pypi-camo.freetls.fastly.net/01d2a816f770b660088549f152c137a373bdfeee/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f67682f6d306e6861776b2f67726166616e615f6170692e7376673f7374796c653d666c61742d737175617265)
What is this library for?
Yet another Grafana API library for Python. Support both 2 and 3 Python versions.
Requirements
You need either 2nd or 3rd version of Python and only the requests
library installed.
Quick start
Install the pip package:
pip install -U grafana_api
And then connect to your Grafana API endpoint:
from grafana_api.grafana_face import GrafanaFace
grafana_api = GrafanaFace(auth='abcde....', host='api.my-grafana-host.com')
# Search dashboards based on tag
grafana_api.search.search_dashboards(tag='applications')
# Find a user by email
grafana_api.users.find_user('test@test.com')
# Create or update a dashboard
grafana_api.dashboard.update_dashboard(dashboard={'dashboard': {...}, 'folderId': 0, 'overwrite': True})
# Delete a dashboard by UID
grafana_api.dashboard.delete_dashboard(dashboard_uid='abcdefgh')
Status of REST API realization ![Coverage Status](https://pypi-camo.freetls.fastly.net/a246a9297364ba055a0a43cb0c2e6e76e68ed51e/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f6d306e6861776b2f67726166616e615f6170692f62616467652e7376673f6272616e63683d6d6173746572)
Work on API implementation still in progress.
API | Status |
---|---|
Admin | + |
Alerting | - |
Annotations | - |
Authentication | +- |
Dashboard | + |
Dashboard Versions | - |
Dashboard Permissions | + |
Data Source | + |
Folder | + |
Folder Permissions | + |
Folder/Dashboard Search | +- |
Organisation | + |
Other | + |
Preferences | + |
Snapshot | - |
Teams | - |
User | + |
Issue tracker
Please report any bugs and enhancement ideas using the grafana_api
issue tracker:
https://github.com/m0nhawk/grafana_api/issues
Feel free to also ask questions on the tracker.
License
grafana_api
is licensed under the terms of the MIT License (see the file
LICENSE).
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
grafana_api-0.5.3.tar.gz
(8.2 kB
view hashes)
Built Distribution
Close
Hashes for grafana_api-0.5.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 421a205bfc6fa06249841ce8036f1a54e165c3d3bb1ac55c7f850fc6f28dd7e1 |
|
MD5 | 76fc8c0256c8940d98871fa187119380 |
|
BLAKE2b-256 | e87913ca415d1f66447bd325dccaaeff7f2b354db21388db96ac4adbebd2587e |