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.1.0.tar.gz (187.8 kB view details)

Uploaded Source

Built Distribution

django_comments_ink-0.1.0-py3-none-any.whl (248.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django-comments-ink-0.1.0.tar.gz
  • Upload date:
  • Size: 187.8 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.1.0.tar.gz
Algorithm Hash digest
SHA256 f3683e0a5cb5de4f3da152c445bb1bb3edf9ea25cab1ac850a74d5fbfef7040f
MD5 22d4d42e03f77fc116906279c81195e0
BLAKE2b-256 67e9380e2e963a31029707e78ef0ba7981ea2b1a1d6352df6f18e5b9b305c892

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_comments_ink-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a38c12bed5164369d5d1a1022a0e22f8d986fbb42b7a3b57a926ed9258ae18d6
MD5 7ec2f28be4d33f8d084f0b4a1a20be4e
BLAKE2b-256 a157a8807d482c9a4dab7307ff144cfc5e5ad577969a1ff250f4df8ed149d66d

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