redash-python 0.0.5

A more complete Python client for the Redash API

Redash API Python Client

python package for interacting with the Redash API

Getting Started

an API key is required in addition to the instance's host URL.

Installation

• Download latest whl file from releases page.
• install it with pip install redash_python.whl

Usage

the API uses SimpleNameSpace objects to represent resources instead of dictionaries. this allows access to the resource's attributes using dot notation.

from redash_python import Redash

client = Redash(base_url="", api_key="")


# get all dashboards
dashboards = client.dashboards.get_all().results

# get specific dashboards by id
dash = client.dashboards.get(1)

# get by slug
dash = client.dashboards.get_by_slug("my-dashboard")

# print slug
print(dash.slug)

# get dashboard widgets
print(dash.widgets)

# get a list of implemented API endpoints
print(client.services)

# get a list of implemented endpoints in a service
print(client.policies)

for more usage examples checkout the demo notebook.

Development

before starting development, install required packages in requirements.txt

pip install -r requirements.txt

Architecture

this library implements a services based architecture splitting each API endpoint group to its own service, on top of which is the Redash class.

redash_python
├── __init__.py
├── redash.py              # services wrapper
├── utils                  # exceptions, encoder, etc.
└── services                # implemented services

Implemented Services

• Dashboards
• Queries
• Data Sources
• Alerts
• Users
• Widgets
• Visualizations

for a full list of implemented methods in each service, print the service object.

>>> print(client.dashboards)
DashboardsService(methods: ['archive', 'create', 'get', 'get_all', 'get_by_slug', 'get_id', 'get_slug', 'publish', 'unarchive', 'unpublish', 'update'])