Skip to main content

cmsplugin-feedback

ci Latest Version Development Status

Feedback form plugin for Django CMS [1]

https://cloud.githubusercontent.com/assets/278630/5002184/c4bbe36a-6a0e-11e4-8c5d-024ec11d2c94.png

Requirements

Python

It works fine and tested under Python 2.7. The following libraries are required

  • Django >=1.5

  • django-cms >= 3.0 (we recommend to use Django CMS 3.0 and higher, contact us if you need prior CMS versions supports and have some issues)

  • django-simple-captcha >= 0.4.1

JavaScript

The feedback form uses jQuery to post form data asynchronously. You should take care of this library and include it to your page directly, or add it to your assets builder, etc.

Installation

$ pip install cmsplugin-feedback

Update your settings.py

INSTALLED_APPS = [
    # django contrib and django cms apps
    'captcha',
    'cmsplugin_feedback',
]

Do not forget to include URLs to urls.py

urlpatterns = patterns('',
    url(r'^captcha/', include('captcha.urls')),
    url(r'^feedback/', include('cmsplugin_feedback.urls')),
    url(r'^', include('cms.urls')),
)

And to migrate your database

django-admin.py migrate captcha cmsplugin_feedback

Notification

Plugin will notify site managers on successful form submit (MANAGERS should be configured for Django). You can disable this behavior in your settings.py

CMS_FEEDBACK_NOTIFY_MANAGERS = False

And tou can change default email subject

CMS_FEEDBACK_NOTIFY_SUBJECT = 'User feedback'

You can write you own successful submit handler

from cmsplugin_feedback.signals import form_submited
from django.dispatch import receiver

@receiver(form_submited)
def submit_handler(sender, message, request, *args, **kwargs):
    pass

Roadmap

  • Python 3 support

  • Both sync and async form posting workflow. To cover number of cases — no javascript (really?); no jquery on the page; you don’t want to use async workflow and want to refresh a page.

  • Form without captcha (if you dont need it or for registered users)

  • Notify site managers about new feedback messages

Changelog

The changelog can be found at repo’s release notes

Contributing

Fork the repo, create a feature branch then send me pull request. Feel free to create new issues or contact me via email.

Translation

You could also help me to translate cmsplugin-feedback to your native language with Transifex

Metadata

Release files for cmsplugin-feedback 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cmsplugin-feedback 0.3.1
File Size Uploaded
cmsplugin-feedback-0.3.1.tar.gz 12.1 kB Details

Release files / cmsplugin-feedback-0.3.1.tar.gz

Download URL cmsplugin-feedback-0.3.1.tar.gz
Size 12.1 kB
Tags Source
SHA-256 checksum
How to use checksums
830cbb99c93633d6804ca2e92cdec3076c58725fe806f6786d64f3ef733875b8
BLAKE2b-256 checksum
How to use checksums
ec53f4f425adc3b0f69c89ee9b24d2cd490867b312c487517f62cb1056d92a64
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.3.1 This release

1 release file

0.3.0

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page