Extension Example static files extension


Extension Basics

Title
Example static files extension
Name
ckanext-example_static
Type
Public extension
Description
Template extension for serving static files in CKAN
CKAN versions

~2.8

Show details
Download-Url (zip)
https://github.com/DataShades/ckanext-example_static.git#egg=ckanext-example_static
Download-Url commit date
2018-01-01
Url to repo
https://github.com/DataShades/ckanext-example_static
Category
Specialized Tools


Background Infos

Description (long)
Show details

This is an example/template extension demonstrating how to serve static files in CKAN extensions. Provides basic structure for including CSS, JavaScript, images, and other static assets in custom CKAN extensions. Python 2.7 compatible. Beta development status. AGPL licensed. NOTE: This is a template extension with placeholder TODO items - requires customization before production use.

Version
0.0.1
Version release date
2018-01-01
Contact name
DataShades
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Install via pip:

git clone https://github.com/DataShades/ckanext-example_static.git

cd ckanext-example_static

pip install -e .

pip install -r requirements.txt

Enable the plugin:

ckan.plugins = example_static

Configuration:

No configuration required by default (template extension).

Developer installation:

git clone https://github.com/DataShades/ckanext-example_static.git

cd ckanext-example_static

python setup.py develop

pip install -r dev-requirements.txt

Testing:

pytest –ckan-ini=test.ini

Use case:

  • Template for extensions needing static files
  • Example of static asset serving in CKAN
  • Learning resource for extension development

NOTE: This is a template/example extension. Customization required before production use.

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