Decidim Metabase is a program written in Ruby and helps to create Metabase collections. The aim is to create easily metacards based on Decidim needs.

Based on the Metabase API, it helps creating Metabase resources based on YAML config files present in ./cards/decidim_cards and config.yml

This program is not a dedicated gem, you must run it using the main.rb file. However we'll probably enhance tests and library and then share it.

First, install dependencies:

bundle install

Ensure file main.rb has the execution rights, if not, add it :

chmod +x main.rb

Pull the defined submodules

Move config.yml.example to config.yml and replace placeholders by your configuration.

Don't forget to setup env variables for metabase connection:

export METABASE_HOST="metabase.example.com" && export METABASE_USERNAME="[email protected]" && export METABASE_PASSWORD="secretpassword"

You can easily execute the program with one of these commands :

make
# OR 
make run
# OR
bundle exec main.rb
# OR
ruby main.rb
# OR 
./main.rb

For now Decidim Metabase simplify operations for our Data team. Please note that the code is not efficient and potential fails are present. At the moment, it shouldn't causes specific issues on your Metabase server.

Contributions are welcome, at the moment it is still in development.

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

Everyone interacting in the DecidimMetabase project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.