Data

Tools

Indexes

Applications

Experiments

Open Source Science

ckanext-contact

A CKAN extension for adding popup contact forms to pages.

https://github.com/naturalhistorymuseum/ckanext-contact

Science Score: 62.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ✓
    Institutional organization owner
    Organization naturalhistorymuseum has institutional domain (www.nhm.ac.uk)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary

Keywords

ckan ckan-extension
Last synced: 6 months ago · JSON representation ·

Repository

A CKAN extension for adding popup contact forms to pages.

Basic Info
  • Host: GitHub
  • Owner: NaturalHistoryMuseum
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 209 KB
Statistics
  • Stars: 5
  • Watchers: 8
  • Forks: 24
  • Open Issues: 5
  • Releases: 19
Topics
ckan ckan-extension
Created over 11 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Support

README.md

The Natural History Museum logo.

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

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 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 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 | | 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 | True (i.e. enabled) |

Usage

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

```html+jinja {% set params = {...} %}

{{ linktext if linktext else _('CONTACT BUTTON TEXT') }}

{% asset 'ckanext-contact/main' %} ```

Where params is a dict with three entries: packageid, resourceid, 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: 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

Owner

  • Name: Natural History Museum
  • Login: NaturalHistoryMuseum
  • Kind: organization
  • Location: London

Citation (CITATION.cff) 

cff-version: 1.2.0
title: CKAN Contact extension
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - name: Natural History Museum
    city: London
    country: GB
    alias: NHM
    email: data@nhm.ac.uk
repository-code: 'https://github.com/NaturalHistoryMuseum/ckanext-contact'
abstract: A CKAN extension for adding popup contact forms to pages.
keywords:
  - ckan
  - ckanext
  - contact
license: GPL-3.0-or-later
version: 2.4.4

GitHub Events

Total
  • Create event: 7
  • Issues event: 1
  • Release event: 3
  • Delete event: 4
  • Member event: 1
  • Issue comment event: 3
  • Push event: 20
  • Pull request event: 16
Last Year
  • Create event: 7
  • Issues event: 1
  • Release event: 3
  • Delete event: 4
  • Member event: 1
  • Issue comment event: 3
  • Push event: 20
  • Pull request event: 16

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 126
  • Total Committers: 4
  • Avg Commits per committer: 31.5
  • Development Distribution Score (DDS): 0.667
Top Committers
Name Email Commits
Alice Butcher a****i@g****m 42
benscott b****n@b****k 40
Josh Humphries j****s@n****k 37
github-actions[bot] g****]@u****m 7
Committer Domains (Top 20 + Academic)
nhm.ac.uk: 1 benscott.co.uk: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 10 minutes
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 10 minutes
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • alycejenni (1)
  • crstn-aiw (1)
Pull Request Authors
  • alycejenni (11)
  • vjf (1)
  • m-sinclair (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 379 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 0
  • Total versions: 16
  • Total maintainers: 1
pypi.org: ckanext-contact

A CKAN extension for adding popup contact forms to pages.

  • Versions: 16
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 379 Last month
Rankings
Dependent packages count: 2.9%
Forks count: 8.4%
Downloads: 10.2%
Average: 16.9%
Dependent repos count: 30.6%
Stargazers count: 32.3%
Maintainers (1)
nhm-data
Last synced: 7 months ago

Dependencies

setup.py pypi
  • requests >=2.10.0
.github/workflows/bump.yml actions
  • actions/checkout v3 composite
  • commitizen-tools/commitizen-action master composite
  • softprops/action-gh-release v1 composite
.github/workflows/main.yml actions
  • actions/checkout v3 composite
.github/workflows/pypi-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
docker/Dockerfile docker
  • naturalhistorymuseum/ckantest 0.2 build
docker-compose.yml docker
  • ckan/ckan-solr 2.9
  • redis latest
docs/requirements.txt pypi
  • mkdocs *
  • mkdocs-gen-files *
  • mkdocs-include-markdown-plugin *
  • mkdocs-material *
  • mkdocs-section-index *
  • mkdocstrings *
pyproject.toml pypi
  • ckantools >=0.3.0