<!--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-statistics
[](https://github.com/NaturalHistoryMuseum/ckanext-statistics/actions/workflows/tests.yml)
[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-statistics)
[](https://github.com/ckan/ckan)
[](https://www.python.org/)
[](https://ckanext-statistics.readthedocs.io)
_A CKAN extension for accessing instance statistics._
<!--header-end-->
# Overview
<!--overview-start-->
Shows statistics for datasets and downloads on the CKAN instance.
**NB**: This extension currently only works with the Natural History Museum's theme extension [ckanext-nhm](https://github.com/NaturalHistoryMuseum/ckanext-nhm).
<!--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-statistics
```
## Installing from source
1. Clone the repository into the `src` folder:
```shell
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-statistics.git
```
2. Activate the virtual env:
```shell
. $INSTALL_FOLDER/bin/activate
```
3. Install via pip:
```shell
pip install $INSTALL_FOLDER/src/ckanext-statistics
```
### 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 'statistics' to the list of plugins in your `$CONFIG_FILE`:
```ini
ckan.plugins = ... statistics
```
2. Upgrade the database to create the tables:
```shell
ckan -c $CONFIG_FILE db upgrade -p statistics
```
<!--installation-end-->
# Configuration
<!--configuration-start-->
These are the options that can be specified in your .ini config file.
| Name | Description |
|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| `ckanext.statistics.resource_ids` | IDs of collection resources (space separated). |
| `ckanext.statistics.gbif_dataset_keys` | GBIF dataset keys (space separated). If not specified, tries `ckanext.gbif.dataset_key`. Defaults to an empty string. |
## Cache settings
These settings are used to directly configure a [beaker cache region](https://beaker.readthedocs.io/en/latest/modules/cache.html) named `ckanext_statistics`. Please see their [configuration docs](https://beaker.readthedocs.io/en/latest/configuration.html) for more information and additional options.
| Name | Description | Example |
|-----------------------------------|---------------------------------------------------|----------------------------|
| `ckanext.statistics.cache.type` | Cache backend. | `ext:redis` |
| `ckanext.statistics.cache.url` | URL for the backend. | `redis://localhost:6379/0` |
| `ckanext.statistics.cache.expire` | Time until the cache content expires, in seconds. | `3600` |
<!--configuration-end-->
# Usage
<!--usage-start-->
## Actions
### `download_statistics`
Statistics for downloads of datasets from the instance.
```python
from ckan.plugins import toolkit
# all of these filters are optional
data_dict = {
'resource_id': RESOURCE_ID,
'year': YEAR,
'month': MONTH
}
toolkit.get_action('download_statistics')(
context,
data_dict
)
```
### `dataset_statistics`
Statistics for dataset records.
```python
from ckan.plugins import toolkit
# these filters are optional
data_dict = {
'resource_id': RESOURCE_ID,
}
toolkit.get_action('dataset_statistics')(
context,
data_dict
)
```
<!--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-statistics",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "CKAN, data, statistics",
"author": null,
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/8e/f6/a66a50257a22287f63e6fa6bbb1ca05e905b59563f051614937b92a70f73/ckanext_statistics-4.0.0.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-statistics\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-statistics/actions/workflows/tests.yml)\n[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-statistics)\n[](https://github.com/ckan/ckan)\n[](https://www.python.org/)\n[](https://ckanext-statistics.readthedocs.io)\n\n_A CKAN extension for accessing instance statistics._\n\n<!--header-end-->\n\n# Overview\n\n<!--overview-start-->\nShows statistics for datasets and downloads on the CKAN instance.\n\n**NB**: This extension currently only works with the Natural History Museum's theme extension [ckanext-nhm](https://github.com/NaturalHistoryMuseum/ckanext-nhm).\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-statistics\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-statistics.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-statistics\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 'statistics' to the list of plugins in your `$CONFIG_FILE`:\n ```ini\n ckan.plugins = ... statistics\n ```\n\n2. Upgrade the database to create the tables:\n ```shell\n ckan -c $CONFIG_FILE db upgrade -p statistics\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| Name | Description |\n|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------|\n| `ckanext.statistics.resource_ids` | IDs of collection resources (space separated). |\n| `ckanext.statistics.gbif_dataset_keys` | GBIF dataset keys (space separated). If not specified, tries `ckanext.gbif.dataset_key`. Defaults to an empty string. |\n\n## Cache settings\n\nThese settings are used to directly configure a [beaker cache region](https://beaker.readthedocs.io/en/latest/modules/cache.html) named `ckanext_statistics`. Please see their [configuration docs](https://beaker.readthedocs.io/en/latest/configuration.html) for more information and additional options.\n\n| Name | Description | Example |\n|-----------------------------------|---------------------------------------------------|----------------------------|\n| `ckanext.statistics.cache.type` | Cache backend. | `ext:redis` |\n| `ckanext.statistics.cache.url` | URL for the backend. | `redis://localhost:6379/0` |\n| `ckanext.statistics.cache.expire` | Time until the cache content expires, in seconds. | `3600` |\n\n<!--configuration-end-->\n\n# Usage\n\n<!--usage-start-->\n## Actions\n\n### `download_statistics`\nStatistics for downloads of datasets from the instance.\n\n```python\nfrom ckan.plugins import toolkit\n\n# all of these filters are optional\ndata_dict = {\n 'resource_id': RESOURCE_ID,\n 'year': YEAR,\n 'month': MONTH\n }\n\ntoolkit.get_action('download_statistics')(\n context,\n data_dict\n)\n```\n\n### `dataset_statistics`\nStatistics for dataset records.\n\n```python\nfrom ckan.plugins import toolkit\n\n# these filters are optional\ndata_dict = {\n 'resource_id': RESOURCE_ID,\n }\n\ntoolkit.get_action('dataset_statistics')(\n context,\n data_dict\n)\n```\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 accessing instance statistics.",
"version": "4.0.0",
"project_urls": {
"changelog": "https://github.com/NaturalHistoryMuseum/ckanext-statistics/blob/main/CHANGELOG.md",
"repository": "https://github.com/NaturalHistoryMuseum/ckanext-statistics"
},
"split_keywords": [
"ckan",
" data",
" statistics"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5379ffc8cb2b8e9e1310eb8b2a3aa706cb2b7f1ffaa3af641caf6ea2f50166a5",
"md5": "34a4aedd7dbca1bb0f3e0cd87995f7c0",
"sha256": "90522590c182a8044a7b83daf28b016888b77382b6b523b1ff3ab80f39f8fd8c"
},
"downloads": -1,
"filename": "ckanext_statistics-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "34a4aedd7dbca1bb0f3e0cd87995f7c0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 29722,
"upload_time": "2025-07-08T13:58:19",
"upload_time_iso_8601": "2025-07-08T13:58:19.602442Z",
"url": "https://files.pythonhosted.org/packages/53/79/ffc8cb2b8e9e1310eb8b2a3aa706cb2b7f1ffaa3af641caf6ea2f50166a5/ckanext_statistics-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8ef6a66a50257a22287f63e6fa6bbb1ca05e905b59563f051614937b92a70f73",
"md5": "5629ff85cb216156cdeb6546f755a4f2",
"sha256": "b4f0905046265777c243f169d7e2f1f603f8ccfe4a233afe1dfc847a3c741c3f"
},
"downloads": -1,
"filename": "ckanext_statistics-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "5629ff85cb216156cdeb6546f755a4f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 31151,
"upload_time": "2025-07-08T13:58:20",
"upload_time_iso_8601": "2025-07-08T13:58:20.650592Z",
"url": "https://files.pythonhosted.org/packages/8e/f6/a66a50257a22287f63e6fa6bbb1ca05e905b59563f051614937b92a70f73/ckanext_statistics-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 13:58:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NaturalHistoryMuseum",
"github_project": "ckanext-statistics",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ckanext-statistics"
}
JSON
