ckanext-mlc-theme 1.0.1

MLCommons CKAN theme

This CKAN theme is designed to be used with the ckanext-theming extension.

It provides a consistent and visually appealing look and feel for the CKAN portal. Designed for the MLCommons project.

Compatibility

[!NOTE] This extension requires ckanext-theming to run.

Screenshots

Below are placeholders for screenshots of the MLC theme in action:

Homepage

Dataset Search / Registry page

Dataset Detail page

Installation

1. Install the Extension

Activate your CKAN virtual environment and install ckanext-mlc-theme and ckanext-theming:

pip install ckanext-theming
# Install ckanext-mlc-theme from source or pip
pip install -e .

Or for development/source installation:

git clone https://github.com/DataShades/ckanext-mlc-theme.git
cd ckanext-mlc-theme
pip install -e .

2. Enable main theme plugin

Add both theming and mlc_theme to the ckan.plugins list in your ckan.ini file:

ckan.plugins = ... theming mlc_theme

ckan.ui.theme = mlcommons-theme
ckan.ui.enable_theming_views = true

[!TIP] Consider pinning ckanext-theming to a specific version (e.g. ckanext-theming==X.Y.Z) in your project's main requirements.

3. Enable override plugin

Add mlc_theme_override to the top of the ckan.plugins list in your ckan.ini file. This allows the theme to override third-party extension templates in a compatible way.

Development

If you'd like to run the test suite, run:

pytest

License

AGPL-3.0