Extension Pen


Extension Basics

Title
Pen
Name
ckanext-pen
Type
Public extension
Description
openid connect auth ckan extension
CKAN versions

~2.10

Show details
Download-Url (zip)
Last commit
2 years ago (2024-01-13 11:48:30)
Url to repo
Category
Authentication & Security


Background Infos

Description (long)
Show details

[![Tests](https://github.com/Github user or organization name/ckanext-pen/workflows/Tests/badge.svg?branch=main)](https://github.com/Github user or organization name/ckanext-pen/actions)

ckanext-pen

ckan OpenID Connect auth extension.

Requirements

TODO: In development on CKAN 2.10.

CKAN version Compatible?
2.9 not tested

Suggested values:

  • “yes”
  • “not tested” - I can’t think of a reason why it wouldn’t work
  • “not yet” - there is an intention to get it working
  • “no”

Installation

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-pen:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/Github user or organization name/ckanext-pen.git cd ckanext-pen pip install -e . pip install -r requirements.txt

  3. Add pen to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Config settings

None at present

TODO: Document any optional config settings here. For example:

# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.pen.some_setting = some_default_value

Developer installation

To install ckanext-pen for development, activate your CKAN virtualenv and do:

git clone https://github.com/Github user or organization name/ckanext-pen.git
cd ckanext-pen
python setup.py develop
pip install -r dev-requirements.txt

Tests

To run the tests, do:

pytest --ckan-ini=test.ini

Releasing a new version of ckanext-pen

If ckanext-pen should be avai

Version
Version release date
(not set)
Contact name
Hiroaki KAWAI
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-pen:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/Github user or organization name/ckanext-pen.git cd ckanext-pen pip install -e . pip install -r requirements.txt

  3. Ad

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