Extension In-App Reporting


Extension Basics

Title
In-App Reporting
Name
ckanext-in_app_reporting
Type
Public extension
Description
Embed Metabase dashboards and cards within CKAN. Provides in-application reporting functionality with user-to-Metabase mapping capabilities.
CKAN versions
Download-Url (zip)
Last commit
2 months ago (2025-12-17 22:01:42)
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

ckanext-in_app_reporting

Embed dashboards functionality for CKAN.

Requirements

Compatibility with core CKAN versions:

CKAN version Compatible?
2.6 and earlier not tested
2.7 not tested
2.8 not tested
2.9 not tested

Installation

To install ckanext-in_app_reporting:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Clone the source and install it on the virtualenv:

    git clone https://github.com/OpenGov/ckanext-in_app_reporting.git
    cd ckanext-in_app_reporting
    pip install -e .
    pip install -r requirements.txt
    
  3. Add in_app_reporting to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. Restart CKAN.

Config settings

None at present.

Plugins

This extension provides three plugins: - in_app_reporting - Main reporting plugin - metabase_card_view - Resource view for Metabase cards - metabase_dashboard_view - Resource view for Metabase dashboards

License

AGPL

Version
0.0.1
Version release date
(not set)
Contact name
Jay Guo
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Requires Python 3.9 or 3.10. Integrates with Metabase for dashboard embedding.

Plugins to configure (ckan.ini)
in_app_reporting metabase_card_view metabase_dashboard_view
CKAN Settings (ckan.ini)
# ckanext.in_app_reporting.some_setting = some_default_value
DB migration to be executed
(not set)
<< back to Extensions