| Name | ckanext-status JSON |
| Version |
2.4.3
JSON |
| download |
| home_page | None |
| Summary | A CKAN extension that adds a 'status' bar to the top of the page. |
| upload_time | 2024-11-04 11:56:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | GPL-3.0-or-later |
| keywords |
ckan
data
status
|
| 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-status
[](https://github.com/NaturalHistoryMuseum/ckanext-status/actions/workflows/tests.yml)
[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-status)
[](https://github.com/ckan/ckan)
[](https://www.python.org/)
[](https://ckanext-status.readthedocs.io)
_A CKAN extension that adds a 'status' bar and an extensible system status page._
<!--header-end-->
# Overview
<!--overview-start-->
This extension allows maintainers to add a simple static message to the top of every page by setting a single configuration option.
For example, it can be used to notify users of planned downtime, unexpected issues with the site, or new features.
It also adds a status page giving an overview of the health of various systems. By default this has very few items, but it is easily extensible by other CKAN extensions.
<!--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-status
```
## Installing from source
1. Clone the repository into the `src` folder:
```shell
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-status.git
```
2. Activate the virtual env:
```shell
. $INSTALL_FOLDER/bin/activate
```
3. Install via pip:
```shell
pip install $INSTALL_FOLDER/src/ckanext-status
```
### 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 'status' to the list of plugins in your `$CONFIG_FILE`:
```ini
ckan.plugins = ... status
```
2. Install `lessc` globally:
```shell
npm install -g "less@~4.1"
```
<!--installation-end-->
# Configuration
<!--configuration-start-->
<!--configuration-end-->
# Usage
<!--usage-start-->
## Status bar
To turn the status bar on, login as a sysadmin and head to the system configuration page.
There, just set the `ckanext.status.message` config option.
To deactivate it, just remove the contents of the text box.
This extension adds content to the `{% block skip %}` section of `page.html`. To add it elsewhere:
```html+jinja
{% if h.status_get_message() %}
{% resource 'ckanext-status/main' %}
<p id="status-bar">{{ h.status_get_message() }}</p>
{% endif %}
```
## Status page
The status page can be found at `/status`, or the JSON response can be accessed from the API at `/api/3/action/status_list`. By default it only contains one status report: the number of queues with pending items. Additional status report items come from other CKAN extensions implementing the `IStatus` interface.
To add status report items in another extension, add the `modify_status_reports` method of the `IStatus` interface in `plugin.py`:
```python
from ckan.plugins import SingletonPlugin, implements
from ckanext.status.interfaces import IStatus
class ExamplePlugin(SingletonPlugin):
implements(IStatus)
def modify_status_reports(self, status_reports):
status_reports.append({
'label': 'Example status',
'value': 'connected',
'group': 'Examples', # can be omitted
'help': 'A description of what this means',
'state': 'good' # valid values: good, ok, bad, neutral
})
return status_reports
```
<!--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-status",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "CKAN, data, status",
"author": null,
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/73/be/3273340fa70e03aeb61a7b274be41dd3229e164dcef165359bfbd4f31b0c/ckanext_status-2.4.3.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-status\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-status/actions/workflows/tests.yml)\n[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-status)\n[](https://github.com/ckan/ckan)\n[](https://www.python.org/)\n[](https://ckanext-status.readthedocs.io)\n\n_A CKAN extension that adds a 'status' bar and an extensible system status page._\n\n<!--header-end-->\n\n# Overview\n\n<!--overview-start-->\nThis extension allows maintainers to add a simple static message to the top of every page by setting a single configuration option.\nFor example, it can be used to notify users of planned downtime, unexpected issues with the site, or new features.\n\nIt also adds a status page giving an overview of the health of various systems. By default this has very few items, but it is easily extensible by other CKAN extensions.\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-status\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-status.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-status\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 'status' to the list of plugins in your `$CONFIG_FILE`:\n ```ini\n ckan.plugins = ... status\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-->\n\n\n<!--configuration-end-->\n\n# Usage\n\n<!--usage-start-->\n## Status bar\n\nTo turn the status bar on, login as a sysadmin and head to the system configuration page.\nThere, just set the `ckanext.status.message` config option.\nTo deactivate it, just remove the contents of the text box.\n\nThis extension adds content to the `{% block skip %}` section of `page.html`. To add it elsewhere:\n\n```html+jinja\n{% if h.status_get_message() %}\n {% resource 'ckanext-status/main' %}\n <p id=\"status-bar\">{{ h.status_get_message() }}</p>\n{% endif %}\n```\n\n## Status page\n\nThe status page can be found at `/status`, or the JSON response can be accessed from the API at `/api/3/action/status_list`. By default it only contains one status report: the number of queues with pending items. Additional status report items come from other CKAN extensions implementing the `IStatus` interface.\n\nTo add status report items in another extension, add the `modify_status_reports` method of the `IStatus` interface in `plugin.py`:\n```python\nfrom ckan.plugins import SingletonPlugin, implements\nfrom ckanext.status.interfaces import IStatus\n\nclass ExamplePlugin(SingletonPlugin):\n implements(IStatus)\n\n def modify_status_reports(self, status_reports):\n status_reports.append({\n 'label': 'Example status',\n 'value': 'connected',\n 'group': 'Examples', # can be omitted\n 'help': 'A description of what this means',\n 'state': 'good' # valid values: good, ok, bad, neutral\n })\n\n return status_reports\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 that adds a 'status' bar to the top of the page.",
"version": "2.4.3",
"project_urls": {
"changelog": "https://github.com/NaturalHistoryMuseum/ckanext-status/blob/main/CHANGELOG.md",
"repository": "https://github.com/NaturalHistoryMuseum/ckanext-status"
},
"split_keywords": [
"ckan",
" data",
" status"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c3c06e3830e37e23dee3bcd2fc882bdf684200f320ca35dff4915613e662b8b",
"md5": "8fd310464920dc98d9603d09b4ebabe8",
"sha256": "13083473e2fa505d473b1d2ad37dc16cfb1bb7d33ff09a2e62a82bf141ef8cee"
},
"downloads": -1,
"filename": "ckanext_status-2.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8fd310464920dc98d9603d09b4ebabe8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 25238,
"upload_time": "2024-11-04T11:56:47",
"upload_time_iso_8601": "2024-11-04T11:56:47.162750Z",
"url": "https://files.pythonhosted.org/packages/2c/3c/06e3830e37e23dee3bcd2fc882bdf684200f320ca35dff4915613e662b8b/ckanext_status-2.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "73be3273340fa70e03aeb61a7b274be41dd3229e164dcef165359bfbd4f31b0c",
"md5": "1a66023dee97ef598b132ba76cce2cbd",
"sha256": "33ea08bd06d6df782949aecf7ea6b36c955df7b300e56915d81c8d0bbaee89d5"
},
"downloads": -1,
"filename": "ckanext_status-2.4.3.tar.gz",
"has_sig": false,
"md5_digest": "1a66023dee97ef598b132ba76cce2cbd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 24251,
"upload_time": "2024-11-04T11:56:48",
"upload_time_iso_8601": "2024-11-04T11:56:48.256579Z",
"url": "https://files.pythonhosted.org/packages/73/be/3273340fa70e03aeb61a7b274be41dd3229e164dcef165359bfbd4f31b0c/ckanext_status-2.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 11:56:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NaturalHistoryMuseum",
"github_project": "ckanext-status",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ckanext-status"
}
