| Name | ckanext-gbif JSON |
| Version |
2.1.11
JSON |
| download |
| home_page | None |
| Summary | A CKAN extension that that connects with the GBIF API. |
| upload_time | 2024-11-04 11:50:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | GPL-3.0-or-later |
| keywords |
ckan
data
gbif
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
<!--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-gbif
[](https://github.com/NaturalHistoryMuseum/ckanext-gbif/actions/workflows/tests.yml)
[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-gbif)
[](https://github.com/ckan/ckan)
[](https://www.python.org/)
[](https://ckanext-gbif.readthedocs.io)
_A CKAN extension that that connects with the GBIF API._
<!--header-end-->
# Overview
<!--overview-start-->
This extension retrieves additional data (e.g. DQIs) from the [GBIF](https://gbif.org) API for a record with an associated GBIF ID.
This extension also provides some templates for displaying these data.
<!--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-gbif
```
## Installing from source
1. Clone the repository into the `src` folder:
```shell
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-gbif.git
```
2. Activate the virtual env:
```shell
. $INSTALL_FOLDER/bin/activate
```
3. Install via pip:
```shell
pip install $INSTALL_FOLDER/src/ckanext-gbif
```
### 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 'gbif' to the list of plugins in your `$CONFIG_FILE`:
```ini
ckan.plugins = ... gbif
```
2. Install `lessc` globally:
```shell
npm install -g "less@~4.1"
```
<!--installation-end-->
# Configuration
<!--configuration-start-->
These are the options that can be specified in your .ini config file.
## Template variables **[REQUIRED]**
| Name | Description |
|---------------------------------|--------------------------------------------------------------------------------|
| `ckanext.gbif.organisation_key` | For linking to the dataset publisher (i.e. https://gbif.org/publisher/ORG_KEY) |
| `ckanext.gbif.dataset_key` | For linking to the dataset itself (i.e. https://gbif.org/dataset/DATA_KEY) |
<!--configuration-end-->
# Usage
<!--usage-start-->
## Actions
### `gbif_record_show`
Get the associated GBIF data for a record.
```python
from ckan.plugins import toolkit
gbif_record = toolkit.get_action(u'gbif_record_show')(context, {
u'occurrence_id': record_gbif_occurrence_id
})
```
## Templates
The templates inherit from `record/specimen.html` and `record/dwc.html` and will insert a link to the GBIF view in the `content_primary_nav` block.
<!--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-gbif",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "CKAN, data, gbif",
"author": null,
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/f8/e1/f82df0f53a718ed1a26f85da00d37b071fd9f266d741d10e0fb3cddda7fb/ckanext_gbif-2.1.11.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-gbif\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-gbif/actions/workflows/tests.yml)\n[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-gbif)\n[](https://github.com/ckan/ckan)\n[](https://www.python.org/)\n[](https://ckanext-gbif.readthedocs.io)\n\n_A CKAN extension that that connects with the GBIF API._\n\n<!--header-end-->\n\n# Overview\n\n<!--overview-start-->\nThis extension retrieves additional data (e.g. DQIs) from the [GBIF](https://gbif.org) API for a record with an associated GBIF ID.\n\nThis extension also provides some templates for displaying these data.\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-gbif\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-gbif.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-gbif\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 'gbif' to the list of plugins in your `$CONFIG_FILE`:\n ```ini\n ckan.plugins = ... gbif\n ```\n\n2. Install `lessc` globally:\n ```shell\n npm install -g \"less@~4.1\"\n ```\n\n<!--installation-end-->\n\n# Configuration\n\n<!--configuration-start-->\nThese are the options that can be specified in your .ini config file.\n\n## Template variables **[REQUIRED]**\n\n| Name | Description |\n|---------------------------------|--------------------------------------------------------------------------------|\n| `ckanext.gbif.organisation_key` | For linking to the dataset publisher (i.e. https://gbif.org/publisher/ORG_KEY) |\n| `ckanext.gbif.dataset_key` | For linking to the dataset itself (i.e. https://gbif.org/dataset/DATA_KEY) |\n\n<!--configuration-end-->\n\n# Usage\n\n<!--usage-start-->\n## Actions\n\n### `gbif_record_show`\nGet the associated GBIF data for a record.\n\n```python\nfrom ckan.plugins import toolkit\n\ngbif_record = toolkit.get_action(u'gbif_record_show')(context, {\n u'occurrence_id': record_gbif_occurrence_id\n })\n```\n\n## Templates\n\nThe templates inherit from `record/specimen.html` and `record/dwc.html` and will insert a link to the GBIF view in the `content_primary_nav` block.\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 that that connects with the GBIF API.",
"version": "2.1.11",
"project_urls": {
"changelog": "https://github.com/NaturalHistoryMuseum/ckanext-gbif/blob/main/CHANGELOG.md",
"repository": "https://github.com/NaturalHistoryMuseum/ckanext-gbif"
},
"split_keywords": [
"ckan",
" data",
" gbif"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "547ad19c68b857c9df7aef6d37872992f34d4d10f206726818b664aaad7838c5",
"md5": "fad37c8a3562b10bf8ee8bab3034e2ce",
"sha256": "870f52dd49c2b807cbedb39cf245e5d3d787319120b0e7776889148840a35778"
},
"downloads": -1,
"filename": "ckanext_gbif-2.1.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fad37c8a3562b10bf8ee8bab3034e2ce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 30077,
"upload_time": "2024-11-04T11:50:36",
"upload_time_iso_8601": "2024-11-04T11:50:36.570458Z",
"url": "https://files.pythonhosted.org/packages/54/7a/d19c68b857c9df7aef6d37872992f34d4d10f206726818b664aaad7838c5/ckanext_gbif-2.1.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f8e1f82df0f53a718ed1a26f85da00d37b071fd9f266d741d10e0fb3cddda7fb",
"md5": "faf1c9d844096c6c47609750695ae107",
"sha256": "e1bcad3c7f91946ed934356c2cdf7911d823b0ab43e11a725840acdbd788d9e4"
},
"downloads": -1,
"filename": "ckanext_gbif-2.1.11.tar.gz",
"has_sig": false,
"md5_digest": "faf1c9d844096c6c47609750695ae107",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 28953,
"upload_time": "2024-11-04T11:50:37",
"upload_time_iso_8601": "2024-11-04T11:50:37.545498Z",
"url": "https://files.pythonhosted.org/packages/f8/e1/f82df0f53a718ed1a26f85da00d37b071fd9f266d741d10e0fb3cddda7fb/ckanext_gbif-2.1.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 11:50:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NaturalHistoryMuseum",
"github_project": "ckanext-gbif",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ckanext-gbif"
}
