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.2.0.tar.gz
(11.3 kB
view hashes)
Built Distribution
Close
Hashes for superset-api-client-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 968115d8a0449d06bb86d6b41d38074a8fb78845213d6ada3faf4acd57e543de |
|
MD5 | 5f269bf69453b34f15f68a00289e19ea |
|
BLAKE2b-256 | 1a30636d311236f14e8f433786fb06e26a2484391b4a85bb2c263a598bdc8aeb |
Close
Hashes for superset_api_client-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 646810d88b9922b5bb718f82946b3274ed5f58da458251ef1c176f60bf1af1f1 |
|
MD5 | d5408e061dedab9eeda3966db829338c |
|
BLAKE2b-256 | a0f83bc6b26cc8e3c156c1d8fbf45dc705e99c865f5bfed96ef0257b5f072115 |