Metadata-Version: 2.4
Name: ckanext-mlc-theme
Version: 1.0.2
Summary: MLC theme
Author: DataShades
License: AGPL
Project-URL: Homepage, https://github.com/DataShades/ckanext-mlc-theme
Keywords: CKAN,theme
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typing-extensions
Dynamic: license-file

[![Tests](https://github.com/DataShades/ckanext-mlc-theme/actions/workflows/test.yml/badge.svg)](https://github.com/DataShades/ckanext-mlc-theme/actions/workflows/test.yml)

MLCommons CKAN theme
---

This CKAN theme is designed to be used with the [ckanext-theming](https://github.com/DataShades/ckanext-theming) extension.

It provides a consistent and visually appealing look and feel for the CKAN portal. Designed for the [MLCommons](https://mlcommons.org/) project.

## Compatibility

| CKAN version | Compatible? |
|---|---|
| 2.11 and earlier | no |
| 2.12 | yes |

> [!NOTE]
> This extension requires [ckanext-theming](https://github.com/DataShades/ckanext-theming) to run.

---

## Screenshots

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

### Homepage
![Homepage Mockup / Screenshot Placeholder](./doc/images/homepage.png)

### Dataset Search / Registry page
![Dataset Search Mockup / Screenshot Placeholder](./doc/images/search.png)

### Dataset Detail page
![Dataset Detail Mockup / Screenshot Placeholder](./doc/images/dataset.png)

---

## Installation

### 1. Install the Extension
Activate your CKAN virtual environment and install `ckanext-mlc-theme` and `ckanext-theming`:

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

Or for development/source installation:

```sh
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:

```ini
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:

```sh
pytest
```

---

## License

[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.en.html)
