Skip to content

Commit 7a72c5b

Browse files
docs: Adjust the documentation (#63)
* docs: Adjust the documentation --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent f3af46e commit 7a72c5b

File tree

4 files changed

+8
-2
lines changed

4 files changed

+8
-2
lines changed

Diff for: README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
The repository includes an SDK for the Grafana API. It's possible to interact with all publicly available Grafana HTTP API endpoints.
33

44
## 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)
5-
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.
5+
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.
66

77
The core features that are implemented inside this library:
88

@@ -349,6 +349,8 @@ In general, my focus on this project is to implement and deliver old and new fea
349349

350350
## Installation
351351

352+
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.
353+
352354
`pip install grafana-api-sdk`
353355

354356
## Example

Diff for: docs/content/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ The following list describes the currently supported features of the Grafana API
5050

5151
## Installation
5252

53+
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.
54+
5355
`pip install grafana-api-sdk`
5456

5557
## Example

Diff for: docs/grafana_api_sdk.md

+2
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ The following list describes the currently supported features of the Grafana API
5050

5151
## Installation
5252

53+
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.
54+
5355
`pip install grafana-api-sdk`
5456

5557
## Example

Diff for: setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
setuptools.setup(
1010
name="grafana-api-sdk",
11-
version="0.4.0",
11+
version="0.4.1",
1212
author="Pascal Zimmermann",
1313
author_email="[email protected]",
1414
description="A Grafana API SDK",

0 commit comments

Comments
 (0)