Add basic example program about how to import a dashboard

Author: amotl

HISTORY.md

@@ -5,6 +5,7 @@
 ## Unreleased
 - Improved Python API authentication when using URL-based connectivity,
   by respecting the `credential` keyword argument
+- Added basic example program about how to import a dashboard
 
 ## 0.4.0 (2024-10-16)
 - Fixed folder argument issue

examples/dashboard_import.py

@@ -0,0 +1,50 @@
+"""
+## About
+
+Upload a Grafana dashboard file in JSON format to the Grafana server.
+
+## Walkthrough
+
+1. Start Grafana
+
+   docker run --rm -it --publish=3000:3000 --env='GF_SECURITY_ADMIN_PASSWORD=admin' grafana/grafana:11.5.2
+
+2. Import dashboard
+
+   wget https://github.com/simonprickett/mongodb-hotel-jobs/raw/refs/heads/main/grafana_dashboard.json
+   python examples/dashboard_import.py grafana_dashboard.json
+
+3. Visit Grafana
+
+   http://admin:admin@localhost:3000/
+   Log in using admin:admin.
+"""
+
+import json
+import sys
+from pathlib import Path
+
+from grafana_import.grafana import Grafana
+
+
+def main():
+
+    # Read single positional CLI argument.
+    dashboard_path = Path(sys.argv[1])
+
+    # Load dashboard JSON from filesystem.
+    dashboard = json.loads(dashboard_path.read_text())
+
+    # Import dashboard JSON to Grafana.
+    # Note: Adjust parameters to match your Grafana.
+    #       You can use many variants to authenticate with its API.
+    gio = Grafana(url="http://localhost:3000", credential=("admin", "admin"))
+    outcome = gio.import_dashboard(dashboard)
+    if outcome:
+        print("Grafana dashboard imported successfully")
+    else:
+        print("Grafana dashboard import failed")
+
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -36,8 +36,11 @@ lint.extend-ignore = [
 ]
 
 lint.per-file-ignores."grafana_import/cli.py" = [
-  # `print` found
-  "T201",
+  "T201",  # `print` found
+]
+
+lint.per-file-ignores."examples/*" = [
+  "T201",  # `print` found
 ]
 
 # ===================