superset-api-client 0.6.0

A simple REST API Client for Apache-Superset

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