A comment system for Django CMS unintrusive and easy to use. Add it to your pages without modifying your models. It is highly customizable!
Project description
DjangoCMS Comments
A comment system for Django CMS unintrusive and easy to use. Add it to your pages without modifying your models. It is highly customizable!
These are the principles of Django CMS Comments:
It does not require javascript to work (but it is recommended).
Almost everything is customizable.
Anonymous users can post comments.
It is easy to use and install.
Comments really are in your website.
Installation
You can install DjangoCMS-Comments From Pypi:
pip install djangocms-comments
…Or you can install directly from source:
git clone https://github.com/Nekmo/djangocms-comments.git cd djangocms-comments python setup.py install
You can also install it from Aldryn cloud:
https://marketplace.django-cms.org/en/addons/browse/djangocms-comments/
Optional depends
user-agents==1.0.1: Improved description of user agent in the comments.
pykismet3==0.1.1: Akismet support.
aldryn-boilerplates>=0.7.4: Bootstrap3 theme.
All optional depends:
pip install user-agents==1.0.1 pykismet3==0.1.1 aldryn-boilerplates>=0.7.4
Configuration
First you need to add djangocms_comments to your INSTALLED_APPS:
INSTALLED_APPS = [ # ... 'djangocms_comments', ]
Now run migrations:
python manage.py migrate
Add to your urlpatterns:
urlpatterns = [ url(r'^djangocms_comments/', include('djangocms_comments.urls')), ]
That’s all!
Optional: Bootstrap3 theme usign Aldryn Boilerplates
Install aldryn-boilerplates: pip install aldryn-boilerplates>=0.7.4.
Configure Aldryn Boilerplates: https://github.com/aldryn/aldryn-boilerplates
Usage
DjangoCMS-Comments includes a plugin. Add the plugin to a page, preferably in a “static placeholder”.
The first time you add a plugin, you need to create a new configuration. You can create different configurations for separate different comments lists on the same page.
For example, you have a blog with two languages. The posts are translated (the id is the same) and you need separate comments. The solution is to create a plugin for each language with a different configuration.
Comments will be associated to the instance in the page. That instance is necessary.
To make the relationship, DjangoCMS-Comments uses a GenericForeignKey. If the primary key is not an integer, the relationship will not work! However, this is not usual.
Settings
You can overwrite the following options in your settings file:
https://github.com/Nekmo/djangocms-comments/blob/master/djangocms_comments/settings.py
Features
Anonymous and registers users comments.
Pretty comment administration.
Akismet support.
Moderation options: spam, hidden, soft deleted, edited…
Easy to add to any page.
Many customization options.
Separates comments systems by language and sites.
Pretty Bootstrap3 integration.
TODO
Social authentication (Twitter, Google, Facebook, Github…).
Reply comments.
Rich text.
Options for authentication methods (disable anonymous…).
Send notifications to admins (new comment, moderation required…).
Sending messages to users (new answers, reply to my comment…).
Contribute
Please feel free to send a pull request. All suggestions are welcome.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.