Python Flask example

.gitignore

@@ -0,0 +1,2 @@
+python/.venv
+python/__pycache__

README.md

@@ -0,0 +1,20 @@
+# Metabase static embedding sample apps
+
+This repo contains code samples demonstrating how embed Metabase dashboards in an app using [static embedding](https://www.metabase.com/docs/latest/embedding/static-embedding).
+
+For [interactive embedding](https://www.metabase.com/docs/latest/embedding/interactive-embedding), check out the following resources:
+
+* [Interactive embedding quick start](https://www.metabase.com/learn/customer-facing-analytics/interactive-embedding-quick-start)
+* [Sample repo for the quick start](https://github.com/metabase/metabase-nodejs-express-interactive-embedding-sample)
+* [Sample with React](https://github.com/metabase/sso-examples/tree/master/app-embed-example)
+
+If you are unsure about what embedding feature is best for you, check out our [live demos](https://www.metabase.com/embedding-demo).
+
+## Free static embedding
+
+Embedding Metabase charts will always be free, but we include a "Powered by Metabase" graphic when using the open source version.
+
+If you'd like to remove the "Powered by Metabase" attribution, check out our [paid plans](https://www.metabase.com/pricing/). In addition to removing the banner, you can also customize the fonts and hide the download buttons for questions. 
+
+## Samples
+* [Python Flask](/python)

python/README.md

@@ -0,0 +1,52 @@
+# Metabase Python static embedding sample
+
+This sample code demonstrates using Metabase static embedding in Python using Flask.
+
+## Pre-requisites
+* Have a running instance of Metabase. If you don't have one
+  * [download the free open source version](https://www.metabase.com/start/oss/) or
+  * [sign up for a free trial of Metabase Cloud](https://www.metabase.com/pricing/).
+* A dashboard to embed. If you don't have one, use X-Rays to let Metabase create one for you. Note down the dashboard ID.
+
+## Preparing the embed
+1. Sign in to your Metabase instance as an admin. 
+2. Go to admin settings and enabling embedding.
+3. Under admin settings/embedding, click on static embedding and copy the embedding secret key.
+
+## Configure the app
+
+1. Paste the secret key into an env var:
+    ```
+    export METABASE_EMBEDDING_SECRET="PASTE_SECRET_HERE"
+    ```
+2. Create an env var pointing to your Metabase site URL, if it's not on http://localhost:3000
+    ```
+    export METABASE_SITE_URL="http://localhost:4000"
+    ```
+3. Create an env var with the ID of the dashboard to embed, if it's not 1:
+    ```
+    export METABASE_EMBED_DASHBOARD_ID="8"
+    ```
+
+## Embed the dashboard
+1. Go to your dashboard, click on the share/embed button at the top
+2. Click on the "Publish" button
+
+# Running the sample
+1. Create the virtual environment:
+    ```
+    python3 -m venv .venv
+    ```
+2. Activate the virtual environment:
+    ```
+    source .venv/bin/activate
+    ```
+3. Install the dependencies:
+    ```
+    pip install -r requirements.txt
+    ```
+4. Start the app:
+    ```
+    flask run -p 9090
+    ```
+5. Open the app at http://localhost:9090

python/app.py

@@ -0,0 +1,26 @@
+import time
+import os
+from urllib.parse import urljoin
+
+from flask import Flask
+import jwt
+
+app = Flask(__name__)
+
+METABASE_SITE_URL = os.environ.get('METABASE_SITE_URL', 'http://localhost:3000')
+METABASE_EMBEDDING_SECRET = os.environ.get('METABASE_EMBEDDING_SECRET')
+METABASE_EMBED_DASHBOARD_ID = int(os.environ.get('METABASE_EMBED_DASHBOARD_ID', '1'))
+
+@app.route("/")
+def static_embed():
+    payload = {
+        "resource": {"dashboard": METABASE_EMBED_DASHBOARD_ID},
+        "params": {        
+        },
+        "exp": round(time.time()) + (60 * 10) # 10 minute expiration
+    }
+    token = jwt.encode(payload, METABASE_EMBEDDING_SECRET, algorithm="HS256")
+    iframeUrl = urljoin(METABASE_SITE_URL, "/embed/dashboard/" + token + "#bordered=true&titled=true")
+    return f'''<script src="{METABASE_SITE_URL}/app/iframeResizer.js"></script>
+            <iframe src="{iframeUrl}" frameborder="0" width="800" height="600" onload="iFrameResize({{}}, this)" allowtransparency></iframe>
+            '''

python/requirements.txt

@@ -0,0 +1,2 @@
+Flask==3.0.0
+PyJWT==2.8.0