Cw 4 + 5 add alerting and data source support

.coveragerc

@@ -19,4 +19,4 @@ exclude_lines =
     raise NotImplementedError
 
     # Don't complain if non-runnable code isn't run:
-    if __name__ == .__main__.:
+    if __name__ == .__main__.:

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

@@ -41,6 +41,14 @@ jobs:
           --wheel
           --outdir dist/
 
+      - name: Setup the GitHub user
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+
+      - name: Update the GitHub pages documentation
+        run: cd docs && mkdocs gh-deploy --force && cd ..
+
       - name: Publish distribution package to PyPI
         if: startsWith(github.ref, 'refs/tags')
         uses: pypa/gh-action-pypi-publish@master

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

@@ -87,27 +87,30 @@ jobs:
           hide-badge: true
           create-new-commit: true
 
-      - name: "Check if coverage badge file existence"
-        id: check_files
-        uses: andstor/file-existence-action@v1
-        with:
-          files: "docs/coverage.svg"
-
       - name: Generate coverage badge
-        if: steps.check_files.outputs.files_exists == 'false'
-        run: coverage-badge -o docs/coverage.svg -f
+        run: coverage-badge -f -o docs/coverage.svg
+
+      - name: Generate documentation
+        run: pydoc-markdown --render-toc && mv build/docs/* docs
+
+      - name: Check changed files
+        uses: tj-actions/verify-changed-files@v8.8
+        id: verify-changed-files
+        with:
+          files: |
+            docs
 
       - name: Commit files
-        if: steps.check_files.outputs.files_exists == 'false'
+        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/coverage.svg
-          git commit -m "Add coverage badge"
+          git add --force docs
+          git commit -m "Add coverage badge and documentation"
 
       - name: Push changes
-        if: steps.check_files.outputs.files_exists == 'false'
         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 }}

README.md

@@ -28,32 +28,94 @@ The repository includes an SDK for the Grafana API. It's possible to communicate
 ### Search
 - Execute a custom query against the Grafana search endpoint
 
+### Datasource
+- Get all datasources
+- Get the datasource by id
+- Get the datasource by uid
+- Get the datasource by name
+- Get the datasource id by name
+- Create a new datasource
+- Update a datasource
+- Delete a datasource by id
+- Delete a datasource by uid
+- Delete a datasource by name
+- Query a datasource by id
+- Enabled datasource permissions
+- Disable datasource permissions
+- Get datasource permissions
+- Add datasource permissions
+- Delete datasource permissions
+
+### Legacy Alerting
+- Get alerts
+- Get alerts by dashboard ids
+- Get alert by id
+- Pause alert by id
+- Unpause alert by id
+
+### Alerting
+- Get all Alertmanager alerts
+- Create or update Alertmanager alerts
+- Get Alertmanager group alerts
+
+- Get all Alertmanager silences
+- Get Alertmanager silence by id
+- Create or update Alertmanager silence
+- Delete Alertmanager silence by id
+- Get Alertmanager status
+- Get the Alertmanager config
+- Create or update the Alertmanager config
+- Delete the Alertmanager config
+- Test the Alertmanager receivers
+- Get Prometheus alerts
+- Get Prometheus rules
+- Get Ruler rules
+- Get a Ruler group
+- Get Ruler groups by the namespace
+- Create or update the Ruler group by the namespace
+- Delete a Ruler group
+- Delete a Ruler namespace
+- Test a datasource rule
+- Test a recipient rule
+- Get the NGAlert organization configuration
+- Get the NGAlert Alertmanager configuration by the organization
+- Create or update the NGAlert organization configuration
+- Delete the NGAlert organization configuration
+
+### Alerting Channels
+- Get all notification channels
+- Get all notification channels (lookup)
+- Get a notification channel by id
+- Get a notification channel by uid
+- Create an notification channel
+- Update a notification channel by id
+- Update a notification channel by uid
+- Delete a notification channel by id
+- Delete a notification channel by uid
+- Test a notification channel
+
 ## Feature timeline
 
 The following table describes the plan to implement the rest of the Grafana API functionality. Please, open an issue and vote them up, if you prefer a faster implementation of an API functionality.
 
 | API endpoint group | Implementation week | Maintainer | PR | State |
 |:------------------:|:-------------------:|:----------:|:--:|:-----:|
-| [Admin HTTP API](https://grafana.com/docs/grafana/latest/http_api/admin/) |                     |            |    |    |
-| [Alerting HTTP API](https://grafana.com/docs/grafana/latest/http_api/alerting/)  | 4 | [ZPascal](https://github.com/ZPascal) |  | Planned |
-| [Alerting Notification Channels HTTP API](https://grafana.com/docs/grafana/latest/http_api/alerting_notification_channels/) | 4 | [ZPascal](https://github.com/ZPascal) |    | Planned |
-| [Annotations HTTP API](https://grafana.com/docs/grafana/latest/http_api/annotations/) |                   |            |    |    |
-| [Authentication HTTP API](https://grafana.com/docs/grafana/latest/http_api/auth/) |                |            |    |    |
-| [Data source HTTP API](https://grafana.com/docs/grafana/latest/http_api/data_source/) | 5 | [ZPascal](https://github.com/ZPascal) |    | Planned |
-| [Datasource Permissions HTTP API](https://grafana.com/docs/grafana/latest/http_api/datasource_permissions/) |        |            |    |    |
-| [External Group Sync HTTP API](https://grafana.com/docs/grafana/latest/http_api/external_group_sync/) |           |            |    |    |
-| [Fine-grained access control HTTP API](https://grafana.com/docs/grafana/latest/http_api/access_control/) |   |            |    |    |
-| [HTTP Preferences API](https://grafana.com/docs/grafana/latest/http_api/preferences/) |                   |            |    |    |
-| [HTTP Snapshot API](https://grafana.com/docs/grafana/latest/http_api/snapshot/) |                      |            |    |    |
-| [Library Element HTTP API](https://grafana.com/docs/grafana/latest/http_api/library_element/) |               |            |    |    |
-| [Licensing HTTP API](https://grafana.com/docs/grafana/latest/http_api/licensing/) |                     |            |    |    |
-| [Organization HTTP API](https://grafana.com/docs/grafana/latest/http_api/org/) |                  |            |    |    |
-| [Other HTTP API](https://grafana.com/docs/grafana/latest/http_api/other/) |                         |            |    |    |
-| [Playlist HTTP API](https://grafana.com/docs/grafana/latest/http_api/playlist/) |                      |            |    |    |
-| [Reporting API](https://grafana.com/docs/grafana/latest/http_api/reporting/) |                          |            |    |    |
-| [Short URL HTTP API](https://grafana.com/docs/grafana/latest/http_api/short_url/) |                     |            |    |    |
-| [Team HTTP API](https://grafana.com/docs/grafana/latest/http_api/team/) |                          |            |    |    |
-| [User HTTP API](https://grafana.com/docs/grafana/latest/http_api/user/) |                          |            |    |    |
+| [Admin HTTP API](https://grafana.com/docs/grafana/latest/http_api/admin/) |  |            |    |  |
+| [Annotations HTTP API](https://grafana.com/docs/grafana/latest/http_api/annotations/) |  |            |    |  |
+| [Authentication HTTP API](https://grafana.com/docs/grafana/latest/http_api/auth/) |  |            |    |  |
+| [External Group Sync HTTP API](https://grafana.com/docs/grafana/latest/http_api/external_group_sync/) |  |            |    |  |
+| [Fine-grained access control HTTP API](https://grafana.com/docs/grafana/latest/http_api/access_control/) |  |            |    |  |
+| [HTTP Preferences API](https://grafana.com/docs/grafana/latest/http_api/preferences/) |  |            |    |  |
+| [HTTP Snapshot API](https://grafana.com/docs/grafana/latest/http_api/snapshot/) |  |            |    |  |
+| [Library Element HTTP API](https://grafana.com/docs/grafana/latest/http_api/library_element/) |  |            |    |  |
+| [Licensing HTTP API](https://grafana.com/docs/grafana/latest/http_api/licensing/) |  |            |    |  |
+| [Organization HTTP API](https://grafana.com/docs/grafana/latest/http_api/org/) | 13 |            |    | In process |
+| [Other HTTP API](https://grafana.com/docs/grafana/latest/http_api/other/) |  |            |    |  |
+| [Playlist HTTP API](https://grafana.com/docs/grafana/latest/http_api/playlist/) |                      |            |    |  |
+| [Reporting API](https://grafana.com/docs/grafana/latest/http_api/reporting/) |  |            |    |  |
+| [Short URL HTTP API](https://grafana.com/docs/grafana/latest/http_api/short_url/) | 13 |            |    | In process |
+| [Team HTTP API](https://grafana.com/docs/grafana/latest/http_api/team/) |  |            |    |  |
+| [User HTTP API](https://grafana.com/docs/grafana/latest/http_api/user/) |  |            |    |  |
 
 ## Installation