Skip to content

silverpond/superset_client

Repository files navigation

Superset Client

A Ruby client for interacting with Apache Superset's REST API.

Installation

Add this line to your application's Gemfile:

gem 'superset_client'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install superset_client

Usage

# Create a new client
client = SupersetClient.new('https://your-superset-instance', 'username', 'password')

# Or if you prefer the explicit form
client = SupersetClient::Client.new('https://your-superset-instance', 'username', 'password')

# Get all charts
charts = client.charts

# Get a specific chart
chart = client.chart(123)

# Create a new chart
new_chart = client.create_chart({
  slice_name: "My New Chart",
  viz_type: "line",
  # ... other params
})

Development

After checking out the repo, run nix-shell to install dependencies. Then, run bundle exec spec to run the tests.

License

The gem is available as open source under the terms of the MIT License.

Why not use superset gem

I couldn't use the superset gem as I had issues installing their dependency (happi). So this is a simple alternative that meets only my needs.

Releases

No releases published

Packages

No packages published