A simple REST API Client for Apache-Superset
Project description
superset-api-client
A Python Client for Apache Superset REST API.
This is a Alpha version. Stability is not guaranteed.
Usage
Setup a superset client:
from supersetapiclient.client import SupersetClient
client = SupersetClient(
host="http://localhost:8080",
username="admin",
password="admin",
)
Quickstart
Get all dashboards or find one by name:
# Get all dashboards
dashboards = client.dashboards.find()
# Get a dashboard by name
dashboard = client.dashboards.find(dashboard_title="Example")[0]
Update dashboard colors, some properties and save changes to server:
# Update label_colors mapping
print(dashboard.colors)
dashboard.update_colors({
"label": "#fcba03"
})
print(dashboard.colors)
# Change dashboard title
dashboard.dashboard_title = "New title"
# Save all changes
dashboard.save()
Export one ore more dashboard
You may export one or more dashboard user client.dashboards
or directly on a dashboard
object
# Export many dashboards
client.dashboards.export(
# Set dashboard ids you would like to export
[
1,
2
],
"./dashboards.json" # A string or a path-like object where export will be saved
)
# Export one dashboard
dashboard.export(
"./dashboard.json"
)
This functionality is also available in the same manner for datasets
Development
You will need Docker and docker-compose in order to run development environment. To start development environnement run:
docker-compose up -d
Project details
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
superset-api-client-0.5.0.tar.gz
(11.6 kB
view hashes)
Built Distribution
Close
Hashes for superset-api-client-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d233f0c892095dfce87e47a0b920927ff93d1d324671dd1a9da4520a31326cd9 |
|
MD5 | bf86c0b17f0b6f373ac25bc49611736b |
|
BLAKE2b-256 | 90d4683612b464ab2870e3727d2f7e8b4425e4a00ab7dc82bb16f751f49e68e5 |
Close
Hashes for superset_api_client-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b739e4a784e686e3961452fcf3addc779bce4acece922a8753d7316214e5dd41 |
|
MD5 | 99c5e69a76203ec8ef27a8388740d443 |
|
BLAKE2b-256 | 02cfe72c4185115573320862dc27d9f81e045fd22d64abfa6f06f1c8ce977aee |