<!--header-start-->
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://data.nhm.ac.uk/images/nhm_logo.svg">
<source media="(prefers-color-scheme: light)" srcset="https://data.nhm.ac.uk/images/nhm_logo_black.svg">
<img alt="The Natural History Museum logo." src="https://data.nhm.ac.uk/images/nhm_logo_black.svg" align="left" width="150px" height="100px" hspace="40">
</picture>
# ckanext-sketchfab
[](https://github.com/NaturalHistoryMuseum/ckanext-sketchfab/actions/workflows/tests.yml)
[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-sketchfab)
[](https://github.com/ckan/ckan)
[](https://www.python.org/)
[](https://ckanext-sketchfab.readthedocs.io)
_A CKAN extension for embedding Sketchfab models as views._
<!--header-end-->
# Overview
<!--overview-start-->
A [Sketchfab](https://sketchfab.com) 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](https://sketchfab.com/NHM_Imaging), and several examples of the plugin in use in [this dataset](https://data.nhm.ac.uk/dataset/3d-cetacean-scanning) on the Museum's Data Portal.
<!--overview-end-->
# Installation
<!--installation-start-->
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](https://github.com/NaturalHistoryMuseum/ckan) 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
```
<!--installation-end-->
# Configuration
<!--configuration-start-->
There are currently no configuration options for this extension.
<!--configuration-end-->
# Usage
<!--usage-start-->
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.
<!--usage-end-->
# Testing
<!--testing-start-->
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
```
<!--testing-end-->
Raw data
{
"_id": null,
"home_page": null,
"name": "ckanext-sketchfab",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "CKAN, data, sketchfab",
"author": null,
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/a3/c6/32374daa5532274daafe725f03548011df01fe693843ceb1022ce5b8ae20/ckanext_sketchfab-2.1.10.tar.gz",
"platform": null,
"description": "<!--header-start-->\n<picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://data.nhm.ac.uk/images/nhm_logo.svg\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://data.nhm.ac.uk/images/nhm_logo_black.svg\">\n <img alt=\"The Natural History Museum logo.\" src=\"https://data.nhm.ac.uk/images/nhm_logo_black.svg\" align=\"left\" width=\"150px\" height=\"100px\" hspace=\"40\">\n</picture>\n\n# ckanext-sketchfab\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-sketchfab/actions/workflows/tests.yml)\n[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-sketchfab)\n[](https://github.com/ckan/ckan)\n[](https://www.python.org/)\n[](https://ckanext-sketchfab.readthedocs.io)\n\n_A CKAN extension for embedding Sketchfab models as views._\n\n<!--header-end-->\n\n# Overview\n\n<!--overview-start-->\nA [Sketchfab](https://sketchfab.com) 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.\n\nYou can see some of the Natural History Museum's 3D scans [on Sketchfab](https://sketchfab.com/NHM_Imaging), and several examples of the plugin in use in [this dataset](https://data.nhm.ac.uk/dataset/3d-cetacean-scanning) on the Museum's Data Portal.\n\n<!--overview-end-->\n\n# Installation\n\n<!--installation-start-->\nPath variables used below:\n- `$INSTALL_FOLDER` (i.e. where CKAN is installed), e.g. `/usr/lib/ckan/default`\n- `$CONFIG_FILE`, e.g. `/etc/ckan/default/development.ini`\n\n## Installing from PyPI\n\n```shell\npip install ckanext-sketchfab\n```\n\n## Installing from source\n\n1. Clone the repository into the `src` folder:\n ```shell\n cd $INSTALL_FOLDER/src\n git clone https://github.com/NaturalHistoryMuseum/ckanext-sketchfab.git\n ```\n\n2. Activate the virtual env:\n ```shell\n . $INSTALL_FOLDER/bin/activate\n ```\n\n3. Install via pip:\n ```shell\n pip install $INSTALL_FOLDER/src/ckanext-sketchfab\n ```\n\n### Installing in editable mode\n\nInstalling 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](https://github.com/NaturalHistoryMuseum/ckan) for a version of v2.9 that uses an updated setuptools if this functionality is something you need.\n\n## Post-install setup\n\n1. Add 'sketchfab' to the list of plugins in your `$CONFIG_FILE`:\n ```ini\n ckan.plugins = ... sketchfab\n ```\n\n<!--installation-end-->\n\n# Configuration\n\n<!--configuration-start-->\nThere are currently no configuration options for this extension.\n\n<!--configuration-end-->\n\n# Usage\n\n<!--usage-start-->\nAfter 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.\n\n<!--usage-end-->\n\n# Testing\n\n<!--testing-start-->\nThere 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.\n\nTo run the tests against ckan 2.9.x on Python3:\n\n1. Build the required images:\n ```shell\n docker compose build\n ```\n\n2. Then run the tests.\n The root of the repository is mounted into the ckan container as a volume by the Docker compose\n configuration, so you should only need to rebuild the ckan image if you change the extension's\n dependencies.\n ```shell\n docker compose run ckan\n ```\n\n<!--testing-end-->\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "A CKAN extension for embedding Sketchfab models as views.",
"version": "2.1.10",
"project_urls": {
"changelog": "https://github.com/NaturalHistoryMuseum/ckanext-sketchfab/blob/main/CHANGELOG.md",
"repository": "https://github.com/NaturalHistoryMuseum/ckanext-sketchfab"
},
"split_keywords": [
"ckan",
" data",
" sketchfab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0787111b43918ba0dd4093b207ea40a8031bff6c374dc56291278a627f8933d3",
"md5": "3061de0f0505c58a5dee8df580032d1e",
"sha256": "699823a2706af55d664e83bd082e495de92665daa3cd56fa5edc5643b7603015"
},
"downloads": -1,
"filename": "ckanext_sketchfab-2.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3061de0f0505c58a5dee8df580032d1e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 19671,
"upload_time": "2024-11-04T11:58:25",
"upload_time_iso_8601": "2024-11-04T11:58:25.060090Z",
"url": "https://files.pythonhosted.org/packages/07/87/111b43918ba0dd4093b207ea40a8031bff6c374dc56291278a627f8933d3/ckanext_sketchfab-2.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3c632374daa5532274daafe725f03548011df01fe693843ceb1022ce5b8ae20",
"md5": "0bf72f8cf82884e7a5832af4c9f8cf04",
"sha256": "6610e45880fe2948a7c12d1569d5decfaf96921acd13814a584ed387d0abac10"
},
"downloads": -1,
"filename": "ckanext_sketchfab-2.1.10.tar.gz",
"has_sig": false,
"md5_digest": "0bf72f8cf82884e7a5832af4c9f8cf04",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 20770,
"upload_time": "2024-11-04T11:58:25",
"upload_time_iso_8601": "2024-11-04T11:58:25.992972Z",
"url": "https://files.pythonhosted.org/packages/a3/c6/32374daa5532274daafe725f03548011df01fe693843ceb1022ce5b8ae20/ckanext_sketchfab-2.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 11:58:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NaturalHistoryMuseum",
"github_project": "ckanext-sketchfab",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ckanext-sketchfab"
}
JSON
