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.4.0.tar.gz
(11.6 kB
view hashes)
Built Distribution
Close
Hashes for superset-api-client-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 852d2323dfe6995fe1b717e38fdf6bec74f430b6be98f978093520dee68e9f74 |
|
MD5 | bdcd1e69890fe500a910b1bcfa962d10 |
|
BLAKE2b-256 | 2d09caba5c0dcf4d5e251b9de67c7fa36a82d532fc8a3a71dd63c09bbf0b4caf |
Close
Hashes for superset_api_client-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e06db5dcb8755d9a582ca519895eee02bde505213405c8502f30c4e8f12ff69d |
|
MD5 | 66667859e0f6faf673994e7277b8971c |
|
BLAKE2b-256 | 8a09cdf7dc0750d2e740e1df1a93f1bfe06ecc8cf4d972f986e684544a1180c8 |