| Name | ckanext-webview JSON |
| Version |
1.1.8
JSON |
| download |
| home_page | |
| Summary | A CKAN extension that adds a view for displaying generic/arbitrary URLs. |
| upload_time | 2023-07-17 08:31:46 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | GPL-3.0-or-later |
| keywords |
ckan
data
webview
|
| 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-webview
[](https://github.com/NaturalHistoryMuseum/ckanext-webview/actions/workflows/main.yml)
[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-webview)
[](https://github.com/ckan/ckan)
[](https://www.python.org/)
[](https://ckanext-webview.readthedocs.io)
_A CKAN extension that adds a view for displaying generic/arbitrary URLs._
<!--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.
<!--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-webview
```
## Installing from source
1. Clone the repository into the `src` folder:
```shell
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-webview.git
```
2. Activate the virtual env:
```shell
. $INSTALL_FOLDER/bin/activate
```
3. Install via pip:
```shell
pip install $INSTALL_FOLDER/src/ckanext-webview
```
### 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 'webview' to the list of plugins in your `$CONFIG_FILE`:
```ini
ckan.plugins = ... webview
```
2. Install `lessc` globally:
```shell
npm install -g "less@~4.1"
```
<!--installation-end-->
# Configuration
<!--configuration-start-->
There are currently no options that can be specified in your .ini config file.
<!--configuration-end-->
# Usage
<!--usage-start-->
After enabling this extension in the list of plugins, the Web view should become available for resources. The URL can be overridden when creating the view.
<!--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-webview",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "CKAN,data,webview",
"author": "",
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/71/3c/09c8487ff723d6be5b5c9d56f20ea41f4e36f97ebafb31892dda9390e59a/ckanext-webview-1.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-webview\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-webview/actions/workflows/main.yml)\n[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-webview)\n[](https://github.com/ckan/ckan)\n[](https://www.python.org/)\n[](https://ckanext-webview.readthedocs.io)\n\n_A CKAN extension that adds a view for displaying generic/arbitrary URLs._\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. For example, it can be used to notify users of planned downtime, unexpected issues with the site, or new features.\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-webview\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-webview.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-webview\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 'webview' to the list of plugins in your `$CONFIG_FILE`:\n ```ini\n ckan.plugins = ... webview\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-->\nThere are currently no options that can be specified in your .ini config file.\n\n<!--configuration-end-->\n\n# Usage\n\n<!--usage-start-->\nAfter enabling this extension in the list of plugins, the Web view should become available for resources. The URL can be overridden when creating the view.\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 view for displaying generic/arbitrary URLs.",
"version": "1.1.8",
"project_urls": {
"changelog": "https://github.com/NaturalHistoryMuseum/ckanext-webview/blob/main/CHANGELOG.md",
"repository": "https://github.com/NaturalHistoryMuseum/ckanext-webview"
},
"split_keywords": [
"ckan",
"data",
"webview"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b03b8efb9e0ae9f2c128612af55db2be778b9bb89f5fff447a0e094976ba9934",
"md5": "88d0a30e09075a79cdab981889a305e5",
"sha256": "469d42f02f214fc7fe64b350a857c8f75528a9f4adbd6516fc179b61f610c816"
},
"downloads": -1,
"filename": "ckanext_webview-1.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "88d0a30e09075a79cdab981889a305e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 20008,
"upload_time": "2023-07-17T08:31:45",
"upload_time_iso_8601": "2023-07-17T08:31:45.055844Z",
"url": "https://files.pythonhosted.org/packages/b0/3b/8efb9e0ae9f2c128612af55db2be778b9bb89f5fff447a0e094976ba9934/ckanext_webview-1.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "713c09c8487ff723d6be5b5c9d56f20ea41f4e36f97ebafb31892dda9390e59a",
"md5": "ab83c30719577c41dfa79c9a1c0f1c11",
"sha256": "abac5641d97b4392de410a36552040ef33a29117d8950b6adb12bee549a2b150"
},
"downloads": -1,
"filename": "ckanext-webview-1.1.8.tar.gz",
"has_sig": false,
"md5_digest": "ab83c30719577c41dfa79c9a1c0f1c11",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 20223,
"upload_time": "2023-07-17T08:31:46",
"upload_time_iso_8601": "2023-07-17T08:31:46.726212Z",
"url": "https://files.pythonhosted.org/packages/71/3c/09c8487ff723d6be5b5c9d56f20ea41f4e36f97ebafb31892dda9390e59a/ckanext-webview-1.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-17 08:31:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NaturalHistoryMuseum",
"github_project": "ckanext-webview",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ckanext-webview"
}
