From 7a72c5bbdf2b8cc23ed9ee57f593ac50bcd8bee9 Mon Sep 17 00:00:00 2001 From: Pascal Zimmermann Date: Fri, 8 Dec 2023 21:57:02 +0100 Subject: [PATCH] docs: Adjust the documentation (#63) * docs: Adjust the documentation --------- Co-authored-by: github-actions[bot] --- README.md | 4 +++- docs/content/index.md | 2 ++ docs/grafana_api_sdk.md | 2 ++ setup.py | 2 +- 4 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4708a0b..e313f7b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ The repository includes an SDK for the Grafana API. It's possible to interact with all publicly available Grafana HTTP API endpoints. ## Differences between [grafana-client](https://github.com/panodata/grafana-client), [grafana_api](https://github.com/m0nhawk/grafana_api/) and the [grafana_api_sdk](https://github.com/ZPascal/grafana_api_sdk) -The grafana-client is only a fork of the non-maintained grafana_api repository. In general, the grafana-client project started at the same time, as I started this project. The corresponding SDK is a completely new project based on nonother projects and includes a few features that are currently not implemented inside the grafana-client. +The grafana-client is only a fork of the non-maintained grafana_api repository. In general, the grafana-client project started at the same time, as I started this project. The corresponding SDK is a completely new project based on nonother projects and includes a few features that are currently not implemented inside the grafana-client. The core features that are implemented inside this library: @@ -349,6 +349,8 @@ In general, my focus on this project is to implement and deliver old and new fea ## Installation +Please be aware to not install the `grafana-api` and `grafana-api-sdk` packages in parallel and the same environment. This result in name clashes, and it's not possible to use the Grafana API SDK. + `pip install grafana-api-sdk` ## Example diff --git a/docs/content/index.md b/docs/content/index.md index 328bcf0..6b57545 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -50,6 +50,8 @@ The following list describes the currently supported features of the Grafana API ## Installation +Please be aware to not install the `grafana-api` and `grafana-api-sdk` packages in parallel and the same environment. This result in name clashes, and it's not possible to use the Grafana API SDK. + `pip install grafana-api-sdk` ## Example diff --git a/docs/grafana_api_sdk.md b/docs/grafana_api_sdk.md index 328bcf0..6b57545 100644 --- a/docs/grafana_api_sdk.md +++ b/docs/grafana_api_sdk.md @@ -50,6 +50,8 @@ The following list describes the currently supported features of the Grafana API ## Installation +Please be aware to not install the `grafana-api` and `grafana-api-sdk` packages in parallel and the same environment. This result in name clashes, and it's not possible to use the Grafana API SDK. + `pip install grafana-api-sdk` ## Example diff --git a/setup.py b/setup.py index 213d81c..a33d1e8 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ setuptools.setup( name="grafana-api-sdk", - version="0.4.0", + version="0.4.1", author="Pascal Zimmermann", author_email="info@theiotstudio.com", description="A Grafana API SDK",