Extension DESQ Customizations


Extension Basics

Title
DESQ Customizations
Name
ckanext-desq
Type
Public extension
Description
Customizations for DESQ data portal. This CKAN plugin requires specific changes to the CKAN configuration and Solr schema.
CKAN versions
Download-Url (zip)
Last commit
8 months ago (2025-06-25 05:48:58)
Url to repo
Category
Regional Government Themes


Background Infos

Description (long)
Show details

ckanext-desq

Customizations for DESQ. This CKAN plugin is not designed to be generic or easily applicable to other data portals. It requires specific changes to the CKAN configuration and the Solr schema.

Requirements

  • Python 3.9
  • Ubuntu packages required by PyICU: sudo apt install libicu-dev python3-icu pkg-config
  • CKAN, DESQ fork, installed with: pip install -e 'git+https://github.com/whiskyechobravo/ckan.git@desq#egg=ckan[requirements]'

Tested under Ubuntu 20.04 and 22.04.

Installation

  1. Activate your CKAN virtualenv, for example: . /usr/lib/ckan/default/bin/activate

  2. Install ckanext-desq in the virtualenv: pip install -e 'git+https://github.com/whiskyechobravo/ckanext-desq.git#egg=ckanext-desq'

  3. Use config/ckan/sample.ini as a replacement to /etc/ckan/default/ckan.ini

  4. Copy the required webfonts to the ckanext/desq/public/webfonts/ directory.

  5. Restart CKAN.

Performing manual backup and restore

Backup:

sudo -u postgres pg_dump --format=custom -d ckan_default > desq-$(date +%Y%m%d-%H%M).pgdump

Restore:

ckan -c /etc/ckan/default/ckan.ini db clean
sudo -u postgres pg_restore --clean --if-exists -d ckan_default < desq-YYYYMMDD-HHMM.pgdump
ckan -c /etc/ckan/default/ckan.ini search-index rebuild

Managing translations

Creating the .pot file:

python setup.py extract_messages

Creating a .po file for a locale:

python setup.py init_catalog --locale LANG

Updating existing translations:

python setup.py update_catalog --locale LANG

Compile translations into a .mo file:

python setup.py compile_catalog --locale LANG
Version
Version release date
(not set)
Contact name
davidlesieur
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Requires DESQ fork of CKAN. Uses custom Solr schema. Needs Ubuntu packages for PyICU. Copy webfonts to public directory.

Plugins to configure (ckan.ini)
desq
CKAN Settings (ckan.ini)
# beaker.session.secret = your_secret
# sqlalchemy.url = postgresql://user:pass@localhost/ckan_default
# api_token.jwt.encode.secret = your_secret
# api_token.jwt.decode.secret = your_secret
# solr_url = http://localhost:8983/solr/ckan
# solr_user = admin
# solr_password = admin
# licenses_group_url = file:///path/to/licenses.json
# ckan.storage_path = /var/lib/ckan/default
DB migration to be executed
(not set)
<< back to Extensions