Data

Tools

Indexes

Applications

Experiments

Open Source Science

ckanext-webview

A CKAN extension for adding arbitrary URLs as resource views

https://github.com/naturalhistorymuseum/ckanext-webview

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization naturalhistorymuseum has institutional domain (www.nhm.ac.uk)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary

Keywords

ckan ckan-extension
Last synced: 11 months ago · JSON representation ·

Repository

A CKAN extension for adding arbitrary URLs as resource views

Basic Info
  • Host: GitHub
  • Owner: NaturalHistoryMuseum
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 110 KB
Statistics
  • Stars: 1
  • Watchers: 8
  • Forks: 0
  • Open Issues: 0
  • Releases: 12
Topics
ckan ckan-extension
Created almost 4 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Support

README.md

The Natural History Museum logo.

ckanext-webview

Tests Coveralls CKAN Python Docs

A CKAN extension that adds a view for displaying generic/arbitrary URLs.

Overview

This extension allows maintainers to add a simple static message to the top of every page by setting a single configuration option. For example, it can be used to notify users of planned downtime, unexpected issues with the site, or new features.

Installation

Path variables used below: - $INSTALL_FOLDER (i.e. where CKAN is installed), e.g. /usr/lib/ckan/default - $CONFIG_FILE, e.g. /etc/ckan/default/development.ini

Installing from PyPI

shell pip install ckanext-webview

Installing from source

  1. Clone the repository into the src folder: shell cd $INSTALL_FOLDER/src git clone https://github.com/NaturalHistoryMuseum/ckanext-webview.git

  2. Activate the virtual env: shell . $INSTALL_FOLDER/bin/activate

  3. Install via pip: shell pip install $INSTALL_FOLDER/src/ckanext-webview

Installing in editable mode

Installing from a pyproject.toml in editable mode (i.e. pip install -e) requires setuptools>=64; however, CKAN 2.9 requires setuptools==44.1.0. See our CKAN fork for a version of v2.9 that uses an updated setuptools if this functionality is something you need.

Post-install setup

  1. Add 'webview' to the list of plugins in your $CONFIG_FILE: ini ckan.plugins = ... webview

  2. Install lessc globally: shell npm install -g "less@~4.1"

Configuration

There are currently no options that can be specified in your .ini config file.

Usage

After enabling this extension in the list of plugins, the Web view should become available for resources. The URL can be overridden when creating the view.

Testing

There is a Docker compose configuration available in this repository to make it easier to run tests. The ckan image uses the Dockerfile in the docker/ folder.

To run the tests against ckan 2.9.x on Python3:

  1. Build the required images: shell docker compose build

  2. Then run the tests. The root of the repository is mounted into the ckan container as a volume by the Docker compose configuration, so you should only need to rebuild the ckan image if you change the extension's dependencies. shell docker compose run ckan

Owner

  • Name: Natural History Museum
  • Login: NaturalHistoryMuseum
  • Kind: organization
  • Location: London

Citation (CITATION.cff) 

cff-version: 1.2.0
title: CKAN Webview extension
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - name: Natural History Museum
    city: London
    country: GB
    alias: NHM
    email: data@nhm.ac.uk
repository-code: 'https://github.com/NaturalHistoryMuseum/ckanext-webview'
abstract: A CKAN extension that adds a view for displaying generic/arbitrary URLs.
keywords:
  - ckan
  - ckanext
  - webview
license: GPL-3.0-or-later
version: 1.1.11

GitHub Events

Total
  • Release event: 2
  • Delete event: 5
  • Issue comment event: 1
  • Push event: 15
  • Pull request event: 13
  • Create event: 6
Last Year
  • Release event: 2
  • Delete event: 5
  • Issue comment event: 1
  • Push event: 15
  • Pull request event: 13
  • Create event: 6

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 185 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 13
  • Total maintainers: 1
pypi.org: ckanext-webview

A CKAN extension that adds a view for displaying generic/arbitrary URLs.

  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 185 Last month
Rankings
Dependent packages count: 6.6%
Downloads: 11.4%
Average: 16.2%
Dependent repos count: 30.6%
Maintainers (1)
nhm-data
Last synced: 11 months ago

Dependencies

.github/workflows/bump.yml actions
  • actions/checkout v3 composite
  • commitizen-tools/commitizen-action master composite
  • softprops/action-gh-release v1 composite
.github/workflows/main.yml actions
  • actions/checkout v3 composite
.github/workflows/pypi-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
docker/Dockerfile docker
  • naturalhistorymuseum/ckantest latest build
docker-compose.yml docker
  • ckan/ckan-solr 2.9
  • redis latest
docs/requirements.txt pypi
  • mkdocs *
  • mkdocs-gen-files *
  • mkdocs-include-markdown-plugin *
  • mkdocs-material *
  • mkdocs-section-index *
  • mkdocstrings *
pyproject.toml pypi
  • ckantools >=0.3.0