Extension Metrics Dashboard


Extension Basics

Title
Metrics Dashboard
Name
ckanext-metrics_dashboard
Type
Public extension
Description
A CKAN extension to display metrics about datasets
CKAN versions
Download-Url (zip)
Last commit
a year ago (2025-01-08 20:55:34)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

ckanext-metrics_dashboard

GitHub Actions PyPI version

A CKAN extension to display metrics about harvest sources.

Features

  • ${CKAN_URL}/report/metrics_dashboard
    • Displays a summary report of number of datasets and harvest sources for each organization
  • ${CKAN_URL}/report/metrics_dashboard/{org}

    • Displays a detailed report of each harvest source in an organization, where org is the ID of your organization
  • CSV Export: A comprehensive table of all harvest sources

  • JSON Export: CSV raw data plus a second key table_data_by_org that includes the same data grouped by organization

This extension is compatible with these versions of CKAN.

CKAN version Compatibility
<=2.8 ???
2.9 yes (with ckanext-datagovtheme==0.1.*)
2.10 yes (with ckanext-datagovtheme>=0.2.1)

Usage

Requirements

These extensions are required for metrics_dashboard:

Development

Requirements

  • GNU Make
  • Docker Compose

Setup

Build the docker containers. You’ll want to do this anytime the dependencies change (requirements.txt, dev-requirements.txt).

$ make build

Start the containers.

$ make up

CKAN will start at localhost:5000.

Start the containers, but don’t start ckan. More debugging instructions here

$ make debug

Open a shell to run commands in the container.

$ docker-compose exec app bash

If you’re unfamiliar with docker-compose, see our cheatsheet and the [official docs](https://docs.docker

Version
Version release date
(not set)
Contact name
U.S. General Services Administration
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Build the docker containers. You’ll want to do this anytime the dependencies change (requirements.txt, dev-requirements.txt).

$ make build

Start the containers.

$ make up

CKAN will start at localhost:5000.

Start the containers, but don’t start ckan. More debugging instructions here

$ make debug

Open a shell to run commands in the container.

$ docker-compose exec app bash

If you’re unfamiliar with docker-compose, see our [cheatsheet]

Plugins to configure (ckan.ini)
metrics_dashboard
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions