Data

Tools

Indexes

Applications

Experiments

Open Source Science

ckanext-sketchfab

A CKAN extension for embedding Sketchfab models as views.

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

Science Score: 62.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
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ✓
    Institutional organization owner
    Organization naturalhistorymuseum has institutional domain (www.nhm.ac.uk)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.7%) to scientific vocabulary

Keywords

ckan ckan-extension sketchfab
Last synced: 9 months ago · JSON representation ·

Repository

A CKAN extension for embedding Sketchfab models as views.

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

README.md

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

shell pip install ckanext-sketchfab

Installing from source

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

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

  3. Install via pip: shell 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: ini 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: 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 Sketchfab 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-sketchfab'
abstract: A CKAN extension for embedding Sketchfab models as views.
keywords:
  - ckan
  - ckanext
  - sketchfab
license: GPL-3.0-or-later
version: 2.1.11

GitHub Events

Total
  • Release event: 2
  • Delete event: 4
  • Member event: 1
  • Issue comment event: 1
  • Push event: 16
  • Pull request event: 13
  • Create event: 5
Last Year
  • Release event: 2
  • Delete event: 4
  • Member event: 1
  • Issue comment event: 1
  • Push event: 16
  • Pull request event: 13
  • Create event: 5

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 45
  • Total Committers: 4
  • Avg Commits per committer: 11.25
  • Development Distribution Score (DDS): 0.289
Top Committers
Name Email Commits
Alice Butcher a****i@g****m 32
github-actions[bot] g****]@u****m 7
Josh Humphries j****s@n****k 4
benscott b****n@b****k 2
Committer Domains (Top 20 + Academic)
benscott.co.uk: 1 nhm.ac.uk: 1

Packages

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

A CKAN extension for embedding Sketchfab models as views.

  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 137 Last month
Rankings
Dependent packages count: 6.6%
Downloads: 11.7%
Average: 20.9%
Forks count: 23.2%
Dependent repos count: 30.6%
Stargazers count: 32.3%
Maintainers (1)
nhm-data
Last synced: 10 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