| Name | ckanext-graph JSON |
| Version |
2.1.10
JSON |
| download |
| home_page | None |
| Summary | A CKAN extension that adds a graph view for resources. |
| upload_time | 2024-11-04 11:51:22 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | GPL-3.0-or-later |
| keywords |
ckan
data
graph
|
| 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-graph
[](https://github.com/NaturalHistoryMuseum/ckanext-graph/actions/workflows/tests.yml)
[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-graph)
[](https://github.com/ckan/ckan)
[](https://www.python.org/)
[](https://ckanext-graph.readthedocs.io)
_A CKAN extension that adds a graph view for resources._
<!--header-end-->
# Overview
<!--overview-start-->
Adds graph views for resources on a CKAN instance. Two types of graph are available: temporal (a line graph showing count over time based on a specified date field), and categorical (a bar chart showing counts for various values in a specified field).
**NB**: the current version of this extension only works with the Natural History Museum's [ElasticSearch datastore CKAN backend](https://github.com/NaturalHistoryMuseum/ckanext-versioned-datastore). _However_, it is designed to be extensible, so if you would like to use this extension with a different backend (e.g. the standard PostgreSQL datastore), please see the [Extending](#extending) section.
<!--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-graph
```
## Installing from source
1. Clone the repository into the `src` folder:
```shell
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-graph.git
```
2. Activate the virtual env:
```shell
. $INSTALL_FOLDER/bin/activate
```
3. Install via pip:
```shell
pip install $INSTALL_FOLDER/src/ckanext-graph
```
### 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 'graph' to the list of plugins in your `$CONFIG_FILE`:
```ini
ckan.plugins = ... graph
```
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.
| Name | Description | Options | Default |
|-------------------------|--------------------------------------------------------------------------------|--------------------|---------------|
| `ckanext.graph.backend` | The name of the backend to use (currently only `elasticsearch` is implemented) | elasticsearch, sql | elasticsearch |
<!--configuration-end-->
# Usage
<!--usage-start-->
## Templates
The view will be added as an option with no further configuration necessary. However, if you wish to override or add content to the template, you can extend `templates/graph/view.html`:
```html+jinja
{% ckan_extends %}
{% block my_new_block %}
<p>Look, some exciting new content.</p>
{% endblock %}
```
# Extending
To use this extension with a datastore backend other than the ElasticSearch backend already implemented, you'll have to subclass from `Query` in `ckanext-graph/ckanext/graph/db.py`.
An unimplemented class for SQL queries is already in the file as an example:
```python
class SqlQuery(Query):
@property
def _date_query(self):
raise NotImplementedError()
@property
def _count_query(self):
raise NotImplementedError()
def run(self):
raise NotImplementedError()
```
If you add a new class, you'll have to add it to the dictionary in `Query.new()` method to make it available as a configurable option.
If you do this, please submit a pull request! Contributions are always welcome.
<!--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-graph",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "CKAN, data, graph",
"author": null,
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/5f/eb/c727435f4789e392fa4aa29d667570604618d76a3713b26c87b07fd90700/ckanext_graph-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-graph\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-graph/actions/workflows/tests.yml)\n[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-graph)\n[](https://github.com/ckan/ckan)\n[](https://www.python.org/)\n[](https://ckanext-graph.readthedocs.io)\n\n_A CKAN extension that adds a graph view for resources._\n\n<!--header-end-->\n\n# Overview\n\n<!--overview-start-->\nAdds graph views for resources on a CKAN instance. Two types of graph are available: temporal (a line graph showing count over time based on a specified date field), and categorical (a bar chart showing counts for various values in a specified field).\n\n\n**NB**: the current version of this extension only works with the Natural History Museum's [ElasticSearch datastore CKAN backend](https://github.com/NaturalHistoryMuseum/ckanext-versioned-datastore). _However_, it is designed to be extensible, so if you would like to use this extension with a different backend (e.g. the standard PostgreSQL datastore), please see the [Extending](#extending) section.\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-graph\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-graph.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-graph\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 'graph' to the list of plugins in your `$CONFIG_FILE`:\n ```ini\n ckan.plugins = ... graph\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| Name | Description | Options | Default |\n|-------------------------|--------------------------------------------------------------------------------|--------------------|---------------|\n| `ckanext.graph.backend` | The name of the backend to use (currently only `elasticsearch` is implemented) | elasticsearch, sql | elasticsearch |\n\n<!--configuration-end-->\n\n# Usage\n\n<!--usage-start-->\n## Templates\n\nThe view will be added as an option with no further configuration necessary. However, if you wish to override or add content to the template, you can extend `templates/graph/view.html`:\n\n```html+jinja\n{% ckan_extends %}\n\n{% block my_new_block %}\n <p>Look, some exciting new content.</p>\n{% endblock %}\n```\n\n\n# Extending\n\nTo use this extension with a datastore backend other than the ElasticSearch backend already implemented, you'll have to subclass from `Query` in `ckanext-graph/ckanext/graph/db.py`.\n\nAn unimplemented class for SQL queries is already in the file as an example:\n\n```python\nclass SqlQuery(Query):\n @property\n def _date_query(self):\n raise NotImplementedError()\n\n @property\n def _count_query(self):\n raise NotImplementedError()\n\n def run(self):\n raise NotImplementedError()\n```\n\nIf you add a new class, you'll have to add it to the dictionary in `Query.new()` method to make it available as a configurable option.\n\nIf you do this, please submit a pull request! Contributions are always welcome.\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 adds a graph view for resources.",
"version": "2.1.10",
"project_urls": {
"changelog": "https://github.com/NaturalHistoryMuseum/ckanext-graph/blob/main/CHANGELOG.md",
"repository": "https://github.com/NaturalHistoryMuseum/ckanext-graph"
},
"split_keywords": [
"ckan",
" data",
" graph"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7799a04f79b942609880211e972f472bf7ddf58c9a2b6b4dbceb331203fbcda1",
"md5": "845dd9e221529e1130517461223fe478",
"sha256": "ad3346eff53cd1fe6d330b8b34d7065fa4c2778ca3a56c239a20b827fc28d188"
},
"downloads": -1,
"filename": "ckanext_graph-2.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "845dd9e221529e1130517461223fe478",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 77510,
"upload_time": "2024-11-04T11:51:21",
"upload_time_iso_8601": "2024-11-04T11:51:21.262120Z",
"url": "https://files.pythonhosted.org/packages/77/99/a04f79b942609880211e972f472bf7ddf58c9a2b6b4dbceb331203fbcda1/ckanext_graph-2.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5febc727435f4789e392fa4aa29d667570604618d76a3713b26c87b07fd90700",
"md5": "7d0c51cb0b1b9dfaf26f171db70d9876",
"sha256": "cd9adcb4d4beab89cce71c4b88eda1579003a92562adbc5e5c40e0845f0cd608"
},
"downloads": -1,
"filename": "ckanext_graph-2.1.10.tar.gz",
"has_sig": false,
"md5_digest": "7d0c51cb0b1b9dfaf26f171db70d9876",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 75036,
"upload_time": "2024-11-04T11:51:22",
"upload_time_iso_8601": "2024-11-04T11:51:22.252296Z",
"url": "https://files.pythonhosted.org/packages/5f/eb/c727435f4789e392fa4aa29d667570604618d76a3713b26c87b07fd90700/ckanext_graph-2.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 11:51:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NaturalHistoryMuseum",
"github_project": "ckanext-graph",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ckanext-graph"
}
