| Name | ckanext-sketchfab JSON |
| Version |
2.1.8
JSON |
| download |
| home_page | |
| Summary | A CKAN extension for embedding Sketchfab models as views. |
| upload_time | 2023-07-17 08:25:43 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | GPL-3.0-or-later |
| keywords |
ckan
data
sketchfab
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
<!--header-start-->
<img src="https://data.nhm.ac.uk/images/nhm_logo.svg" align="left" width="150px" height="100px" hspace="40"/>
# ckanext-sketchfab
[](https://github.com/NaturalHistoryMuseum/ckanext-sketchfab/actions/workflows/main.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": "",
"name": "ckanext-sketchfab",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "CKAN,data,sketchfab",
"author": "",
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/cf/d5/48e542c50cd3628cf053c08d5825af764f76837d413817872de1adbefcbf/ckanext-sketchfab-2.1.8.tar.gz",
"platform": null,
"description": "<!--header-start-->\n<img src=\"https://data.nhm.ac.uk/images/nhm_logo.svg\" align=\"left\" width=\"150px\" height=\"100px\" hspace=\"40\"/>\n\n# ckanext-sketchfab\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-sketchfab/actions/workflows/main.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.8",
"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": "8bccf310b413a314a6f85e986c5461747f74d067c210d1e6a829a6e447b85c7c",
"md5": "7c11d64318bf70725200c40b30538087",
"sha256": "bb86afca2f8f97a8a7c74f2b9345423b94de2ebc2d8fd88b96eec86639965811"
},
"downloads": -1,
"filename": "ckanext_sketchfab-2.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7c11d64318bf70725200c40b30538087",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 19592,
"upload_time": "2023-07-17T08:25:42",
"upload_time_iso_8601": "2023-07-17T08:25:42.673560Z",
"url": "https://files.pythonhosted.org/packages/8b/cc/f310b413a314a6f85e986c5461747f74d067c210d1e6a829a6e447b85c7c/ckanext_sketchfab-2.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cfd548e542c50cd3628cf053c08d5825af764f76837d413817872de1adbefcbf",
"md5": "2d3b2206c99ca4b712412208e01bf348",
"sha256": "f86ec7249cbc9417a5fb4bb1c2c12dd6976a8b8cccbd28f6ef749f3ea87d6522"
},
"downloads": -1,
"filename": "ckanext-sketchfab-2.1.8.tar.gz",
"has_sig": false,
"md5_digest": "2d3b2206c99ca4b712412208e01bf348",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 20507,
"upload_time": "2023-07-17T08:25:43",
"upload_time_iso_8601": "2023-07-17T08:25:43.959782Z",
"url": "https://files.pythonhosted.org/packages/cf/d5/48e542c50cd3628cf053c08d5825af764f76837d413817872de1adbefcbf/ckanext-sketchfab-2.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-17 08:25:43",
"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"
}
