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

Uploaded Source

Built Distribution

django_comments_ink-0.0.1-py3-none-any.whl (273.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django-comments-ink-0.0.1.tar.gz
  • Upload date:
  • Size: 198.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for django-comments-ink-0.0.1.tar.gz
Algorithm Hash digest
SHA256 424db529b1d7f986c9f0233554bde7d3b5663690d591f99d39c029220524874b
MD5 0ffc4c82d33abe899e81f106868d64cc
BLAKE2b-256 7155f6f1bb114f3595b427e69c371420384084ba1bff7e35ae43dd5482882450

See more details on using hashes here.

File details

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

File metadata

  • Download URL: django_comments_ink-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 273.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for django_comments_ink-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9b695cd78e2b29a0e997cce2b30fe9b5d70ca938e264d7f4d547b0e72f382ecf
MD5 19e2aaa563d1e163f3752b2b199b4fc2
BLAKE2b-256 67414bd96b967bcec06187877058e99be35ce4846e384b311835b6249722c797

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