Skip to main content

Django pluggable commenting app with comment threads, follow-up notifications, mail confirmation, comment reactions and votes, and comment moderation. It supersedes django-comments-xtd.

Project description

# django-comments-ink [![example workflow](https://github.com/comments-ink/django-comments-ink/workflows/tests/badge.svg)](https://github.com/comments-ink/django-comments-ink/actions/workflows/ci-pipeline.yml) [![Code Coverage](coverage.svg)]((https://github.com/comments-ink/django-comments-ink/actions/workflows/ci-pipeline.yml))

Don’t use it yet: It’s still under migration from django-comments-xtd to django-comments-ink.

A Django pluggable application that adds comments to your project.

The current master branch represents is a work-in-progress towards v3.0.0. It has not been released yet as a package in PyPI. The current stable version is based on the branch [v2](https://github.com/danirus/django-comments-ink/tree/v2) and is [available at PyPI](https://pypi.org/project/django-comments-ink/).

Example of django-comments-ink with one thread level and the default theme:

![Example image of using django-comments-ink](https://github.com/danirus/django-comments-ink/blob/main/docs/images/cover.png)

It extends [django-contrib-comments](https://pypi.python.org/pypi/django-contrib-comments) with the following features:

  • Thread support, so comments can be nested.

  • Customizable maximum thread level, either for all models or on a per app.model basis.

  • Optional notifications on follow-up comments via email.

  • Mute links to allow cancellation of follow-up notifications.

  • Comment confirmation via email when users are not authenticated.

  • Comments hit the database only after they have been confirmed.

  • Registered users can send reactions to comments, as like/dislike, or other customizable set of reactions.

  • Registered users can suggest comment’s removal.

  • Comment pagination support.

  • Template tags to list comments and to add the comment form.

  • Emails sent through threads (can be disable to allow other solutions, like a Celery app).

  • Fully functional JavaScript plugin (framework free vanilla JavaScript).

  • No CSS external dependency.

Example sites and tests work under officially Django supported versions:

  • Django 4.0, 3.2, 3.1

  • Python 3.10, 3.9, 3.8

Additional Dependencies:

  • django-contrib-comments >=2.2,<2.3

  • djangorestframework >=3.12,<3.14

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

django-comments-ink-0.2.0.tar.gz (188.5 kB view details)

Uploaded Source

Built Distribution

django_comments_ink-0.2.0-py3-none-any.whl (248.8 kB view details)

Uploaded Python 3

File details

Details for the file django-comments-ink-0.2.0.tar.gz.

File metadata

  • Download URL: django-comments-ink-0.2.0.tar.gz
  • Upload date:
  • Size: 188.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for django-comments-ink-0.2.0.tar.gz
Algorithm Hash digest
SHA256 59856d6b05953bc7eeaa2370a8a00dc5d82b2e89e4d647923a0abca5f3c6222f
MD5 1ef6ad137b0798577d6aac40754925ce
BLAKE2b-256 647d731cc4addb9b70aa62dd1482302e36d8d92a8a06082e6c96abe3c0d4eded

See more details on using hashes here.

File details

Details for the file django_comments_ink-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_comments_ink-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8fc269a7f208dc0229d2e3aa6c4c7271503cd9e032a31062816727612a372c41
MD5 9452f6abbfa9bb4c148900e83c4742c6
BLAKE2b-256 12f9918a1b7b068cb789f33205cf2f506d6f69fa5da538760115e65e67aeccbd

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