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 environment run:
docker-compose up -d
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
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
Built Distribution
Hashes for superset-api-client-0.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae970c009725600fead02aa94aaac70f6e676216fddc759f7b4456857a5281e7 |
|
MD5 | b7b7fea768c2017de024ef08405b0691 |
|
BLAKE2b-256 | f2467a69e717df0838f4dbf98c0e9a66e0fc5f739cba02557290cef85658e481 |
Hashes for superset_api_client-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97c7bc25722041ce0554e4636522250054d570e230694c48b75fa82204c701fe |
|
MD5 | 30b6f231ecab19d8e7d53006db114056 |
|
BLAKE2b-256 | abc91a7bb80d652b62e7f4c4fac8f95cd19c21ac863e4b6f7d2681fb3945cda2 |