[FEAT] Add HTTP/2 support (#34)

* feat: Add HTTP/2 support
*fix: Update the Python version inside the GH Action
*fix: Update the GH lint Action
*fix: Remove the unused import
*feat: Adjust the API implementation and add new integration tests
*docs: Add the documentation
*feat: Adjust the GH Actions
---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: ZPascal

.github/workflows/integrationtest.yml

@@ -5,27 +5,48 @@ on:
     - cron: '0 22 * * 1'
   push:
     branches: [ main ]
-  pull_request:
-    branches: [ main ]
   workflow_dispatch:
+  workflow_call:
 
 jobs:
 
-  test:
+  grafana-api-sdk-test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.10' ]
 
     steps:
       - uses: actions/checkout@v3
 
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+          cache: 'pip'
+
       - name: Install the requirements
         run: pip install -r requirements.txt
 
-      - name: Execute the integrationtests
-        run: python3 --version && python3 -m unittest discover tests/integrationtest
+      - name: Execute the integrationtests (http1.1)
+        run: python3 -m unittest discover tests/integrationtest
+        env:
+          GRAFANA_HOST: ${{ secrets.GRAFANA_HOST }}
+          GRAFANA_TOKEN: ${{ secrets.GRAFANA_TOKEN }}
+          GRAFANA_DASHBOARD_PATH: ${{ secrets.GRAFANA_DASHBOARD_PATH }}
+          GRAFANA_DASHBOARD_NAME: ${{ secrets.GRAFANA_DASHBOARD_NAME }}
+          GRAFANA_USERNAME: ${{ secrets.GRAFANA_USERNAME }}
+          GRAFANA_PASSWORD: ${{ secrets.GRAFANA_PASSWORD }}
+          HTTP2: "False"
+
+      - name: Execute the integrationtests (http2)
+        run: python3 -m unittest discover tests/integrationtest
         env:
           GRAFANA_HOST: ${{ secrets.GRAFANA_HOST }}
           GRAFANA_TOKEN: ${{ secrets.GRAFANA_TOKEN }}
           GRAFANA_DASHBOARD_PATH: ${{ secrets.GRAFANA_DASHBOARD_PATH }}
           GRAFANA_DASHBOARD_NAME: ${{ secrets.GRAFANA_DASHBOARD_NAME }}
           GRAFANA_USERNAME: ${{ secrets.GRAFANA_USERNAME }}
           GRAFANA_PASSWORD: ${{ secrets.GRAFANA_PASSWORD }}
+          HTTP2: "True"

.github/workflows/publish-to-pypi.yml

@@ -24,7 +24,7 @@ jobs:
           cache: 'pip'
 
       - name: Install the requirements
-        run: pip install -r requirements.txt
+        run: pip install -r requirements.txt && pip install setuptools~=65.5.1
 
       - name: Install pypa/build
         run: >-

.github/workflows/pull-request-checks.yml

@@ -6,11 +6,11 @@ on:
 
 jobs:
 
-  test:
+  pr-test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.x' ]
+        python-version: [ '3.10' ]
 
     steps:
       - uses: actions/checkout@v3
@@ -28,11 +28,11 @@ jobs:
       - name: Execute the unittests
         run: python3 -m unittest discover tests/unittests
 
-  lint:
+  pr-lint:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.x' ]
+        python-version: [ '3.10' ]
 
     steps:
       - uses: actions/checkout@v3
@@ -44,20 +44,18 @@ jobs:
           architecture: x64
           cache: 'pip'
 
-      - name: Install the requirements
-        run: pip install -r requirements.txt
-
       - name: Execute the linting checks
-        uses: reviewdog/action-flake8@v3.7.0
+        uses: reviewdog/action-flake8@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           flake8_args: --config=.flake8
+          fail_on_error: true
 
-  coverage:
+  pr-coverage:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.x' ]
+        python-version: [ '3.10' ]
 
     steps:
       - uses: actions/checkout@v3
@@ -81,15 +79,59 @@ jobs:
       - name: Execute the coverage checks
         uses: MishaKav/[email protected]
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
           pytest-coverage-path: ./pytest-coverage.txt
           junitxml-path: ./pytest.xml
           hide-badge: true
-          create-new-commit: true
+          create-new-comment: false
 
       - name: Generate coverage badge
         run: coverage-badge -f -o docs/coverage.svg
 
+      - name: Check changed files
+        uses: tj-actions/verify-changed-files@v16
+        id: verify-changed-files
+        with:
+          files: |
+            docs
+
+      - name: Commit files
+        if: steps.verify-changed-files.outputs.files_changed == 'true'
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add --force docs
+          git commit -m "docs: Add coverage badge"
+
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        if: steps.verify-changed-files.outputs.files_changed == 'true'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.head_ref }}
+
+  pr-documentation:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.9' ]
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+          cache: 'pip'
+
+      - name: Install the requirements
+        run: pip install pydoc-markdown==4.6.3 mkdocs mkdocs-material
+
       - name: Generate documentation
         run: pydoc-markdown --render-toc && rm -rf docs/content && mv build/docs/* docs
 
@@ -106,11 +148,15 @@ jobs:
           git config --local user.email "github-actions[bot]@users.noreply.github.com"
           git config --local user.name "github-actions[bot]"
           git add --force docs
-          git commit -m "docs: Add coverage badge and documentation"
+          git commit -m "docs: Add the documentation"
 
       - name: Push changes
         uses: ad-m/github-push-action@master
         if: steps.verify-changed-files.outputs.files_changed == 'true'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: ${{ github.head_ref }}
+          branch: ${{ github.head_ref }}
+
+  pr-integrationtest:
+    uses: ./.github/workflows/integrationtest.yml
+    secrets: inherit

README.md

@@ -1,12 +1,15 @@
 # Grafana API SDK ![Coverage report](https://github.com/ZPascal/grafana_api_sdk/blob/main/docs/coverage.svg)
-The repository includes a Python SDK for the Grafana API. It's possible to communicate with the Grafana API endpoints. Another feature of the SDK is the possibility to specify the used folder for the dashboard.
+The repository includes an SDK for the Grafana API. It's possible to interact with all public 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 and based on non-other project and include a few features that are currently not implemented inside the grafana-client.
 
-The main feature that is implemented inside this library:
+The core features that are implemented inside this library:
 
-- Grafana V8 Alerting API support (possibility to communicate (currently read only) with the attached Prometheus and Alertmanager)
+- All public Grafana API (HTTP) endpoints are supported
+- Full API support for Grafana legacy alerting, current alerting, alerting channels and alert provisioning
+- Possibility to specify custom and self-signed certificates
+- HTTP/2 support
 
 In general my focus inside this project is to implement and deliver old and new features from the Grafana API, to document all features and functionality clear and to increase the overall test coverage of the project.
 
@@ -230,6 +233,7 @@ In general my focus inside this project is to implement and deliver old and new
 - Renew login session 
 - Get health status
 - Get metrics
+- Get Plugin metrics
 
 ### Licensing
 - Check license availability

docs/content/grafana_api/api.md

@@ -3,6 +3,8 @@
 * [api](#api)
   * [Api](#api.Api)
     * [call\_the\_api](#api.Api.call_the_api)
+    * [prepare\_api\_string](#api.Api.prepare_api_string)
+    * [create\_the\_http\_api\_client](#api.Api.create_the_http_api_client)
 
 <a id="api"></a>
 
@@ -61,3 +63,43 @@ The method execute a defined API call against the Grafana endpoints
 
 - `api_call` _any_ - Returns the value of the api call
 
+<a id="api.Api.prepare_api_string"></a>
+
+#### prepare\_api\_string
+
+```python
+@staticmethod
+def prepare_api_string(query_string: str) -> str
+```
+
+The method includes a functionality to prepare the api string for the queries
+
+**Arguments**:
+
+- `query_string` _str_ - Specify the corresponding query string
+  
+
+**Returns**:
+
+- `query_string` _str_ - Returns the adjusted query string
+
+<a id="api.Api.create_the_http_api_client"></a>
+
+#### create\_the\_http\_api\_client
+
+```python
+def create_the_http_api_client(
+        headers: dict = None) -> Union[httpx.Client, httpx.AsyncClient]
+```
+
+The method includes a functionality to create the corresponding HTTP client
+
+**Arguments**:
+
+- `headers` _dict_ - Specify the optional inserted headers (Default None)
+  
+
+**Returns**:
+
+- `client` _Union[httpx.Client, httpx.AsyncClient]_ - Returns the corresponding client
+

docs/content/grafana_api/model.md

@@ -79,6 +79,7 @@ The class includes all necessary variables to establish a connection to the Graf
 - `username` _str_ - Specify the username of the Grafana system
 - `password` _str_ - Specify the password of the Grafana system
 - `timeout` _float_ - Specify the timeout of the Grafana system
+- `http2_support` _bool_ - Specify if you want to use HTTP/2
 - `ssl_context` _ssl.SSLContext_ - Specify the custom ssl context of the Grafana system
 - `num_pools` _int_ - Specify the number of the connection pool
 - `retries` _any_ - Specify the number of the retries. Please use False as parameter to disable the retries

docs/content/grafana_api/other-http.md

@@ -6,6 +6,7 @@
     * [renew\_login\_session\_based\_on\_remember\_cookie](#other_http.OtherHTTP.renew_login_session_based_on_remember_cookie)
     * [get\_health\_status](#other_http.OtherHTTP.get_health_status)
     * [get\_metrics](#other_http.OtherHTTP.get_metrics)
+    * [get\_plugin\_metrics](#other_http.OtherHTTP.get_plugin_metrics)
 
 <a id="other_http"></a>
 
@@ -92,13 +93,49 @@ The method includes a functionality to get the health information
 #### get\_metrics
 
 ```python
-def get_metrics() -> str
+def get_metrics(basic_auth_username: str = None,
+                basic_auth_password: str = None) -> str
 ```
 
 The method includes a functionality to get the Grafana metrics information
 
+**Arguments**:
+
+- `basic_auth_username` _str_ - Specify the optional basic auth username
+- `basic_auth_password` _str_ - Specify the optional basic auth password
+  
+
+**Raises**:
+
+- `Exception` - Unspecified error by executing the API call
+  
+
+**Returns**:
+
+- `api_call` _str_ - Returns the metrics information
+
+<a id="other_http.OtherHTTP.get_plugin_metrics"></a>
+
+#### get\_plugin\_metrics
+
+```python
+def get_plugin_metrics(plugin_id: str,
+                       basic_auth_username: str = None,
+                       basic_auth_password: str = None) -> str
+```
+
+The method includes a functionality to get the Grafana plugin metrics information
+
+**Arguments**:
+
+- `plugin_id` _str_ - Specify the plugin id
+- `basic_auth_username` _str_ - Specify the optional basic auth username
+- `basic_auth_password` _str_ - Specify the optional basic auth password
+  
+
 **Raises**:
 
+- `ValueError` - Missed specifying a necessary value
 - `Exception` - Unspecified error by executing the API call