Skip to main content

A CKAN extension for adding popup contact forms to pages.

Project description

ckanext-contact

Tests Coveralls CKAN Python Docs

A CKAN extension for adding popup contact forms to pages.

Overview

Borrows much of the contact form code from ckanext-surrey.

An example can be seen on the Natural History Museum's Data Portal when clicking "Contact dataset curator."

This extension now includes Google's reCAPTCHA for preventing spam submissions.

Installation

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

pip install ckanext-contact

Installing from source

  1. Clone the repository into the src folder:

    cd $INSTALL_FOLDER/src
    git clone https://github.com/NaturalHistoryMuseum/ckanext-contact.git
    
  2. Activate the virtual env:

    . $INSTALL_FOLDER/bin/activate
    
  3. Install via pip:

    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 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:

    ckan.plugins = ... contact
    
  2. To use reCAPTCHA, you must register a site with the Google reCAPTCHA service and add your API key and secret in the configuration.

Configuration

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

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

Usage

Add the following HTML where you want the contact button to appear:

{% 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>

{% resource 'ckanext-contact/main' %}

Where params is a dict with three entries: package_id, resource_id, record_id (all of which are optional).

Testing

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:

    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.

    docker-compose run ckan
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckanext-contact-2.1.1.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

ckanext_contact-2.1.1-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file ckanext-contact-2.1.1.tar.gz.

File metadata

  • Download URL: ckanext-contact-2.1.1.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for ckanext-contact-2.1.1.tar.gz
Algorithm Hash digest
SHA256 ee01a3cb37e38c29d9b7c125d157e539f352239fbac90fbccbbd7d2d8bd08336
MD5 4ab2e74fce94aae6775a2167508fa6a5
BLAKE2b-256 6c6450f6dd8f752188c3d9c5e67437123435e5ee19af4f182c5f29405ffe6d32

See more details on using hashes here.

File details

Details for the file ckanext_contact-2.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ckanext_contact-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 acd954e365f375ec460b5f317053de49558494c8ec51798d9aa705313d1e698b
MD5 0694edcb9db6bb0a93f4b650d777757b
BLAKE2b-256 672a8fd89fb95c5356f01608893a7023d0dcbffb6bb0056ba932a3be4b88df77

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page