A Django app to integrate Apache Superset dashboards into a Django application
Project description
django-superset-integration
django-superset-integration is a Django app to integration Apache Superset dashboards into a Django application.
Quick start
- Add
django_superset_integrationto yourINSTALLED_APPSsetting like this:
INSTALLED_APPS = [
...,
"django_superset_integration",
...,
]
- Include the superset-integration URLconf in your project
urls.pylike this:
path("superset_integration/", include("django_superset_integration.urls")),
- You will need a cryptography Fernet key, so you need to install cryptography:
pip install cryptography
- Generate a Fernet key in a python terminal:
from cryptography.fernet import Fernet
FERNET_KEY = Fernet.generate_key()
-
The result is a bytestring like
b'jozEHFGLKJHEFUIHEZ4'. Copy ONLY the content of the string, not the b nor the quotation marks -
In your env variables, create a variable
FERNET_KEYwith the copied content as value -
Add a variable
ENCRYPTION_KEYin yoursettings.pyreferencing your env variableFERNET_KEY:
ENCRYPTION_KEY = os.environ.get("FERNET_KEY", "").encode()
- By default, all dashboard data will be displayed. You can override this by creating your own filtering function and adding it in your
settings.py:
RLS_FUNCTION = "my_app.my_module.create_rls_clause"
Your function must take a parameter user and return a SQL rls clause like this : [{"clause": "1=1"}]
(where you replace 1=1 by the clause you want).
See Superset documentation for more information
-
Make sure that your Superset instance parameter
GUEST_TOKEN_JWT_EXP_SECONDSis more than 300 (5 minutes). Otherwise it will expire before it can be refreshed. For example, set it to 600 (10 minutes). -
In the template where you want to integrate the dashboard, add the following in your
<head>:
<link href="{% static 'css/ponctual-rejects.css' %}" rel="stylesheet"/>
- Then add the following at the emplacement where you want the dashboard:
{% load static %}
...
{% include "django_superset_integration/superset-integration.html" %}
-
Run
python manage.py migrateto create the models. -
Start the development server and visit the admin site to create a
SupersetInstanceobject.- address: the address of your Superset instance
- username: the username that allows to connect via api to your instance. By default : superset_api You need to have a service account with minimal permissions to embed dashboards. See Superset documentation for more info.
- password: the password that allows to connect via api to your instance.
-
After you have created a
SupersetInstanceobject, create aSupersetDashboardobject.- integration_id: the integration id given by Superset to integrate your dashboard
- name: a name for your dashboard
- domain: (foreign key) the SupersetInstance object corresponding to the instance where the dashboard is
- comment: (optional) a plain text comment
- superset_link: (optional) the link to your dashboard in Superset
-
In the view where you want to integrate the dashboard, in
get_context_data, add the following:
from django_superset_integration.models import SupersetDashboard
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
...
dashboard_name = "THE NAME OF YOUR DASHBOARD FROM STEP 13"
dashboard = SupersetDashboard.objects.get(name__iexact=dashboard_name)
context["dashboard_integration_id"] = dashboard.integration_id
context["dashboard_id"] = dashboard.id
context["superset_domain"] = dashboard.domain.address
...
return context
- That should be it!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_superset_integration-0.1.11.tar.gz.
File metadata
- Download URL: django_superset_integration-0.1.11.tar.gz
- Upload date:
- Size: 12.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.10.17 Linux/6.11.0-1013-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cba63d8041024482292a674747b6061a755ebbe9c3a42bdca893f6994ea37fd4
|
|
| MD5 |
6298255336019390250bf946facc61f0
|
|
| BLAKE2b-256 |
17e60fe21b62687f137bd377bfbcefbda0832d16a00e6b9cbd2a31c1bd54c1b6
|
File details
Details for the file django_superset_integration-0.1.11-py3-none-any.whl.
File metadata
- Download URL: django_superset_integration-0.1.11-py3-none-any.whl
- Upload date:
- Size: 13.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.10.17 Linux/6.11.0-1013-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aee96b675dde30574e5a601a8a08fc6cbfa7dc79031534cb657f4373b792b0ea
|
|
| MD5 |
9cbef7553ccf8e2e0f765ca42d11c28f
|
|
| BLAKE2b-256 |
e68468ad8f81d399f3c40a8a5335690854a3310c50a043e8c8d6d295c00c082c
|
