Skip to content

Latest commit

 

History

History
executable file
·
107 lines (74 loc) · 3.91 KB

README.md

File metadata and controls

executable file
·
107 lines (74 loc) · 3.91 KB
Raw
The Natural History Museum logo.

ckanext-sketchfab

Tests Coveralls CKAN Python Docs

A CKAN extension for embedding Sketchfab models as views.

Overview

A Sketchfab view can be added to any resource, regardless of whether the original data are related to the model. The view can use either the resource's URL (if the resource links directly to a sketchfab model) or one can be specified when creating the view.

You can see some of the Natural History Museum's 3D scans on Sketchfab, and several examples of the plugin in use in this dataset on the Museum's Data Portal.

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

pip install ckanext-sketchfab

Installing from source

  1. Clone the repository into the src folder:

    cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-sketchfab.git

  2. Activate the virtual env:

    . $INSTALL_FOLDER/bin/activate

  3. Install via pip:

    pip install $INSTALL_FOLDER/src/ckanext-sketchfab

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 'sketchfab' to the list of plugins in your $CONFIG_FILE: 
    ckan.plugins = ... sketchfab

Configuration

There are currently no configuration options for this extension.

Usage

After installing, the "Sketchfab" view type will become available for resource maintainers. Add the new view and provide the URL to a Sketchfab model where prompted.

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:

    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.

    docker compose run ckan