Skip to content

Commit

Permalink
docs: Adjust the documentation (#63)
Browse files Browse the repository at this point in the history
* docs: Adjust the documentation

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
ZPascal and github-actions[bot] authored Dec 8, 2023
1 parent f3af46e commit 7a72c5b
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/grafana_api_sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

setuptools.setup(
name="grafana-api-sdk",
version="0.4.0",
version="0.4.1",
author="Pascal Zimmermann",
author_email="[email protected]",
description="A Grafana API SDK",
Expand Down

0 comments on commit 7a72c5b

Please sign in to comment.