A simple REST API Client for Apache-Superset
Project description
Superset Client
A Python Client for Apache Superset REST API.
This is an Alpha version. Stability is not guaranteed.
Usage
Install the package:
pip install superset-client
Setup a superset client:
from supersetapiclient.client import SupersetClient
client = SupersetClient(
host="http://localhost:8080",
username="admin",
password="admin",
)
When developping in local (only), you may need to accept insecure transport (i.e. http).
This is NOT recommanded outside of local development environement, that is requesting localhost
.
import os
os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'
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()
Documentation
Contributing
Before committing to this repository, you must have pre-commit installed, and install the following pre-commit hooks:
pre-commit install --install-hooks -t pre-commit -t pre-push
License
This project is licensed under the Apache 2.0 License - see the LICENSE file for details
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
Hashes for idg-superset-client-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f1566d8711203cb6cb7745d8f6c3b0c3a5f2d171d4252ae2254b9646a879a73 |
|
MD5 | c956fcd8a491507b4df3d6eea9a17d8b |
|
BLAKE2b-256 | 6c1460f64ddd0834f4b3c1e8c8cebf9897b94deff04b6c5a9de2a9beb972f9da |