| Name | ckanext-contact JSON |
| Version |
2.4.0
JSON |
| download |
| home_page | |
| Summary | A CKAN extension for adding popup contact forms to pages. |
| upload_time | 2024-01-15 09:48:36 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | GPL-3.0-or-later |
| keywords |
ckan
data
contact
|
| 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-contact
[](https://github.com/NaturalHistoryMuseum/ckanext-contact/actions/workflows/main.yml)
[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-contact)
[](https://github.com/ckan/ckan)
[](https://www.python.org/)
[](https://ckanext-contact.readthedocs.io)
_A CKAN extension for adding popup contact forms to pages._
<!--header-end-->
# Overview
<!--overview-start-->
Borrows much of the contact form code from [ckanext-surrey](https://github.com/CityofSurrey/ckanext-surrey).
An example can be seen on the Natural History Museum's [Data Portal](https://data.nhm.ac.uk) when clicking "_Contact dataset curator._"
This extension now includes Google's [reCAPTCHA](https://www.google.com/recaptcha) for preventing spam submissions.
<!--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-contact
```
## Installing from source
1. Clone the repository into the `src` folder:
```shell
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-contact.git
```
2. Activate the virtual env:
```shell
. $INSTALL_FOLDER/bin/activate
```
3. Install via pip:
```shell
pip install $INSTALL_FOLDER/src/ckanext-contact
```
### 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 'contact' to the list of plugins in your `$CONFIG_FILE`:
```ini
ckan.plugins = ... contact
```
2. To use reCAPTCHA, you must register a site with the Google [reCAPTCHA](https://www.google.com/recaptcha) service and add your API key and secret in the [configuration](#configuration).
<!--installation-end-->
# Configuration
<!--configuration-start-->
These are the options that can be specified in your .ini config file.
## Email
| Name | Description | Default |
|--------------------------------------------|---------------------------------------------------|---------------------------------|
| `ckanext.contact.mail_to` | Email address to submit to | `email_to` |
| `ckanext.contact.recipient_name` | Name of the recipient | `ckan.site_title` |
| `ckanext.contact.subject` | Email subject for the submitted form | 'Contact/Question from visitor' |
| `ckanext.contact.add_timestamp_to_subject` | Whether to append a timestamp to the subject line | `false` |
| `ckanext.contact.subject_prefix` | A prefix to add to the subject before sending | '' |
## Recaptcha
| Name | Description | Default |
|---------------------------------------|------------------------------------------|-----------------------|
| `ckanext.contact.recaptcha_v3_key` | API key for the reCAPTCHA service. | False (i.e. disabled) |
| `ckanext.contact.recaptcha_v3_secret` | API secret for the reCAPTCHA service. | False (i.e. disabled) |
| `ckanext.contact.recaptcha_v3_action` | `data-module-action` for the form/button | |
## Other
| Name | Description | Default |
|-------------------------------|------------------------------------------------------------------------------------------------------|---------------------|
| `ckanext.contact.check_email` | Set to False to disable checking email addresses via [pyIsEmail](https://pypi.org/project/pyIsEmail) | True (i.e. enabled) |
<!--configuration-end-->
# Usage
<!--usage-start-->
Add the following HTML where you want the contact button to appear:
```html+jinja
{% set params = {...} %}
<a class="btn btn-primary" data-module="modal-contact" data-module-template="{{ h.get_contact_form_template_url(params) }}" href="{{ h.url_for('contact.form', **params) }}" title="{{ _('Contact') }}">
<i class="fas fa-envelope"></i>{{ link_text if link_text else _('CONTACT BUTTON TEXT') }}
</a>
{% asset 'ckanext-contact/main' %}
```
Where `params` is a dict with three entries: package_id, resource_id, record_id (all of which are optional).
<!--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-contact",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "CKAN,data,contact",
"author": "",
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/99/58/0166e984f0bf5049ef83f751a84c320fbe8f7b088a682e4b10692bface01/ckanext-contact-2.4.0.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-contact\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-contact/actions/workflows/main.yml)\n[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-contact)\n[](https://github.com/ckan/ckan)\n[](https://www.python.org/)\n[](https://ckanext-contact.readthedocs.io)\n\n_A CKAN extension for adding popup contact forms to pages._\n\n<!--header-end-->\n\n# Overview\n\n<!--overview-start-->\nBorrows much of the contact form code from [ckanext-surrey](https://github.com/CityofSurrey/ckanext-surrey).\n\nAn example can be seen on the Natural History Museum's [Data Portal](https://data.nhm.ac.uk) when clicking \"_Contact dataset curator._\"\n\nThis extension now includes Google's [reCAPTCHA](https://www.google.com/recaptcha) for preventing spam submissions.\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-contact\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-contact.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-contact\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 'contact' to the list of plugins in your `$CONFIG_FILE`:\n ```ini\n ckan.plugins = ... contact\n ```\n\n2. To use reCAPTCHA, you must register a site with the Google [reCAPTCHA](https://www.google.com/recaptcha) service and add your API key and secret in the [configuration](#configuration).\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## Email\n\n| Name | Description | Default |\n|--------------------------------------------|---------------------------------------------------|---------------------------------|\n| `ckanext.contact.mail_to` | Email address to submit to | `email_to` |\n| `ckanext.contact.recipient_name` | Name of the recipient | `ckan.site_title` |\n| `ckanext.contact.subject` | Email subject for the submitted form | 'Contact/Question from visitor' |\n| `ckanext.contact.add_timestamp_to_subject` | Whether to append a timestamp to the subject line | `false` |\n| `ckanext.contact.subject_prefix` | A prefix to add to the subject before sending | '' |\n\n## Recaptcha\n\n| Name | Description | Default |\n|---------------------------------------|------------------------------------------|-----------------------|\n| `ckanext.contact.recaptcha_v3_key` | API key for the reCAPTCHA service. | False (i.e. disabled) |\n| `ckanext.contact.recaptcha_v3_secret` | API secret for the reCAPTCHA service. | False (i.e. disabled) |\n| `ckanext.contact.recaptcha_v3_action` | `data-module-action` for the form/button | |\n\n## Other\n\n| Name | Description | Default |\n|-------------------------------|------------------------------------------------------------------------------------------------------|---------------------|\n| `ckanext.contact.check_email` | Set to False to disable checking email addresses via [pyIsEmail](https://pypi.org/project/pyIsEmail) | True (i.e. enabled) |\n\n<!--configuration-end-->\n\n# Usage\n\n<!--usage-start-->\nAdd the following HTML where you want the contact button to appear:\n\n```html+jinja\n{% set params = {...} %}\n\n<a class=\"btn btn-primary\" data-module=\"modal-contact\" data-module-template=\"{{ h.get_contact_form_template_url(params) }}\" href=\"{{ h.url_for('contact.form', **params) }}\" title=\"{{ _('Contact') }}\">\n <i class=\"fas fa-envelope\"></i>{{ link_text if link_text else _('CONTACT BUTTON TEXT') }}\n</a>\n\n{% asset 'ckanext-contact/main' %}\n```\n\nWhere `params` is a dict with three entries: package_id, resource_id, record_id (all of which are optional).\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 adding popup contact forms to pages.",
"version": "2.4.0",
"project_urls": {
"changelog": "https://github.com/NaturalHistoryMuseum/ckanext-contact/blob/main/CHANGELOG.md",
"repository": "https://github.com/NaturalHistoryMuseum/ckanext-contact"
},
"split_keywords": [
"ckan",
"data",
"contact"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "17628501b2cd20d846bae1f219533c3175510705870bcd686d2fc488dab93f8d",
"md5": "9700a5a835bc72dec20434b25f4803e1",
"sha256": "562ea582e154cfe2735c1d05df580c92926a9ffdf20c761b8c0e1ad7b90d9fda"
},
"downloads": -1,
"filename": "ckanext_contact-2.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9700a5a835bc72dec20434b25f4803e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 33926,
"upload_time": "2024-01-15T09:48:33",
"upload_time_iso_8601": "2024-01-15T09:48:33.829609Z",
"url": "https://files.pythonhosted.org/packages/17/62/8501b2cd20d846bae1f219533c3175510705870bcd686d2fc488dab93f8d/ckanext_contact-2.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "99580166e984f0bf5049ef83f751a84c320fbe8f7b088a682e4b10692bface01",
"md5": "2eee79c1c59e43935b10d68248459a9d",
"sha256": "97ecc80757d7c73cde7cf6e91e9b4dcc07453936b717044dffb774d282896193"
},
"downloads": -1,
"filename": "ckanext-contact-2.4.0.tar.gz",
"has_sig": false,
"md5_digest": "2eee79c1c59e43935b10d68248459a9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 30388,
"upload_time": "2024-01-15T09:48:36",
"upload_time_iso_8601": "2024-01-15T09:48:36.385810Z",
"url": "https://files.pythonhosted.org/packages/99/58/0166e984f0bf5049ef83f751a84c320fbe8f7b088a682e4b10692bface01/ckanext-contact-2.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-15 09:48:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NaturalHistoryMuseum",
"github_project": "ckanext-contact",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ckanext-contact"
}
