Pelican Static Comment System
=============================
Pelican Static Comment System allows you to add static comments to your
articles.
.. image:: https://img.shields.io/pypi/v/minchin.pelican.plugins.static-comments.svg?style=flat
:target: https://pypi.python.org/pypi/minchin.pelican.plugins.static-comments/
:alt: PyPI version number
.. image:: https://img.shields.io/badge/-Changelog-success
:target: https://github.com/MinchinWeb/minchin.pelican.plugins.static-comments/blob/master/CHANGELOG.rst
:alt: Changelog
.. image:: https://img.shields.io/pypi/pyversions/minchin.pelican.plugins.static-comments?style=flat
:target: https://pypi.python.org/pypi/minchin.pelican.plugins.static-comments/
:alt: Supported Python version
.. image:: https://img.shields.io/pypi/l/minchin.pelican.plugins.static-comments.svg?style=flat&color=green
:target: https://github.com/MinchinWeb/minchin.pelican.plugins.static-comments/blob/master/LICENSE.txt
:alt: License
.. image:: https://img.shields.io/pypi/dm/minchin.pelican.plugins.static-comments.svg?style=flat
:target: https://pypi.python.org/pypi/minchin.pelican.plugins.static-comments/
:alt: Download Count
Comments are received via email (i.e. you don't need to maintain a server to
receive comments). Comments are stored in files in formats that can be
processed by Pelican (e.g., Markdown, reStructuredText). Each comment resides
in its own file.
Features
--------
- Static comments for each article
- Replies to comments
- Avatars and `Identicons <https://en.wikipedia.org/wiki/Identicon>`__
- Comment Atom feed for each article
- Easily style-able via themes
- Python 3 support
See it in action here:
`bernhard.scheirle.de <http://bernhard.scheirle.de/posts/2014/March/29/static-comments-via-email/>`__
+-------------------+-----------------------------+-----------------------------------------------+
| Author | Website | Github |
+===================+=============================+===============================================+
| Bernhard Scheirle | http://bernhard.scheirle.de | https://github.com/Scheirle |
+-------------------+-----------------------------+-----------------------------------------------+
| William Minchin | https://blog.minchin.ca | https://github.com/MinchinWeb/blog.minchin.ca |
+-------------------+-----------------------------+-----------------------------------------------+
Instructions
------------
- `Quickstart Guide <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/quickstart.md>`__
- `Installation and basic usage <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/installation.md>`__
- `Import existing comments <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/import.md>`__
- `Avatars and identicons <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/avatars.md>`__
- `Comment Atom feed <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/feed.md>`__
- `[Developer] How to do a release <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/how-to-release.md>`__
PyPi
------------
The Pelican Comment System is now also in the Python Package Index and can
easily installed via:
::
pip install minchin.pelican.plugins.static-comments
Requirements
------------
Pelican 3.4 or newer is required.
To create identicons, the Python Image Library is needed. Therefore you either
need PIL **or** Pillow (recommended). If you install the plugin from pip,
Pillow will automatically be installed.
**Install Pillow manually via:**
::
pip install Pillow
If you don't want avatars or identicons, this plugin works fine without
PIL/Pillow. You will, however, see a warning that identicons are deactivated
(as expected).
Change Log
----------
The change log can be found in the `CHANGELOG.rst <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/CHANGELOG.rst>`__
file.
Change Log
==========
All notable changes to this project will be documented in this file.
This project adheres to `Semantic Versioning <http://semver.org/>`__.
2.1.2 - 2023-08-09
------------------
\
Support
~~~~~~~
- blacklist ``autoloader`` v1.2.0
2.1.1 - 2022-04-29
------------------
\
Fixed
~~~~~
- Readme link targets
2.1.0 - 2022-04-10
------------------
\
Fixed
~~~~~
- generating slugs should now work across Pelican 3.7, 4.0-4.2, and 4.5+. The
slugs should also match "old" versions (pre 2.0.0) of the plugin as well. Use
the form `replyto: 1md` (no period for file extension start).
Added
~~~~~
- add prefix ("[Static Comments]") to all logging messages
2.0.0 - 2022-04-08
------------------
\
Fixed
~~~~~
- [**This is no longer the case with v2.1.0**.] the `replyto` field now takes the
whole filename, rather than "eating" the dot in filenames. E.g. old:
`replyto: 1md`; new: `replyto: 1.md`. You will need to update any comments
that contain this field. If you don't update, a warning will appear when
you generate your site.
Added
~~~~~
- automatically activates on Pelican 4.5+. If automatic loading isn't working,
refer to the installation instructions for my `autoloader
<https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader>`__ plugin.
- Blogger comment exporter script is now available on the commandline as
`blogger-comment-export`
Changes
~~~~~~~
- move GitHub repo to `MinchinWeb/minchin.pelican.plugins.static-comments
<https://github.com/MinchinWeb/minchin.pelican.plugins.static-comments>`__
- plugin name, as listed in `PLUGINS` in `pelicanconf.py`, is now
`minchin.pelican.plugin.static_comments`. Generally, though, the entry can be
completely removed and instead rely on the auto-loading of plugins provided
by Pelican 4.5+.
Unresolved
~~~~~~~~~~
- documentation may (in places) still need to be updated
1.4.0 - 2017-02-20
------------------
\
Added
~~~~~
- add ``setup.py`` to allow posting plugin to PyPI `PR
#862 <https://github.com/getpelican/pelican-plugins/pull/862>`__
1.3.0 - 2017-01-10
------------------
\
Added
~~~~~
- add
`blogger\_comment\_export.py <import/blogger_comment_export.py>`__
script to export comments from Blogger XML export and `associated
documentation <docs/import.md>`__ `PR
#835 <https://github.com/getpelican/pelican-plugins/pull/835>`__
1.2.2 - 2016-12-19
------------------
\
Fixed
~~~~~
- Correct jQuery expression in cancelReply method `PR
#820 <https://github.com/getpelican/pelican-plugins/pull/820>`__
1.2.1 - 2016-09-22
------------------
\
Fixed
~~~~~
- Add support for the autoreload mode of pelican `PR
#782 <https://github.com/getpelican/pelican-plugins/pull/782>`__
`Fixes
pelican#1949 <https://github.com/getpelican/pelican/issues/1949>`__
1.2.0 - 2016-05-23
------------------
\
Fixed - Documentation
~~~~~~~~~~~~~~~~~~~~~
- Correct template path `PR
#713 <https://github.com/getpelican/pelican-plugins/pull/713>`__
Added - Documentation
~~~~~~~~~~~~~~~~~~~~~
- Adds Quickstart guide + default theme `PR
#686 <https://github.com/getpelican/pelican-plugins/pull/686>`__
Fixed
~~~~~
- Fix mailto link: use '' instead of '' `PR
#720 <https://github.com/getpelican/pelican-plugins/pull/720>`__
- Fix comparison of offset-naive and offset-aware datetimes `PR
#722 <https://github.com/getpelican/pelican-plugins/pull/722>`__
Added
~~~~~
- Logs a warning if the parent of a comment can not be found `PR
#715 <https://github.com/getpelican/pelican-plugins/pull/715>`__
1.1.0 - 2016-02-18
------------------
\
Fixed - Documentation
~~~~~~~~~~~~~~~~~~~~~
- Updated old URLs `PR
#677 <https://github.com/getpelican/pelican-plugins/pull/677>`__
Changed
~~~~~~~
- Main logic runs a bit earlier (allows other plugins to access
comments earlier) `PR
#677 <https://github.com/getpelican/pelican-plugins/pull/677>`__
- The writer to generate the feeds can now be exchanged (via a normal
pelican writer plugin) `PR
#677 <https://github.com/getpelican/pelican-plugins/pull/677>`__
1.0.1 - 2015-10-04
------------------
\
Fixed - Documentation
~~~~~~~~~~~~~~~~~~~~~
- Add commas indicating tuple (``PELICAN_COMMENT_SYSTEM_AUTHORS``) `PR
#579 <https://github.com/getpelican/pelican-plugins/pull/579>`__
1.0.0 - 2014-11-05
------------------
\
Added
~~~~~
- Basic static comments
- Atom Feeds
- Replies to comments
- Avatars and identicons
This change log uses `Keep a CHANGELOG <http://keepachangelog.com/>`__
as a template.
Raw data
{
"_id": null,
"home_page": "https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments",
"name": "minchin.pelican.plugins.static-comments",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "William Minchin",
"author_email": "w_minchin@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/23/a1/b40c2aba37b762b2714920a0f2ec961bcd5072ccdc7a986d4c8bef28eedd/minchin.pelican.plugins.static-comments-2.1.2.tar.gz",
"platform": "any",
"description": "Pelican Static Comment System\r\n=============================\r\n\r\nPelican Static Comment System allows you to add static comments to your\r\narticles.\r\n\r\n.. image:: https://img.shields.io/pypi/v/minchin.pelican.plugins.static-comments.svg?style=flat\r\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.static-comments/\r\n :alt: PyPI version number\r\n\r\n.. image:: https://img.shields.io/badge/-Changelog-success\r\n :target: https://github.com/MinchinWeb/minchin.pelican.plugins.static-comments/blob/master/CHANGELOG.rst\r\n :alt: Changelog\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/minchin.pelican.plugins.static-comments?style=flat\r\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.static-comments/\r\n :alt: Supported Python version\r\n\r\n.. image:: https://img.shields.io/pypi/l/minchin.pelican.plugins.static-comments.svg?style=flat&color=green\r\n :target: https://github.com/MinchinWeb/minchin.pelican.plugins.static-comments/blob/master/LICENSE.txt\r\n :alt: License\r\n\r\n.. image:: https://img.shields.io/pypi/dm/minchin.pelican.plugins.static-comments.svg?style=flat\r\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.static-comments/\r\n :alt: Download Count\r\n\r\nComments are received via email (i.e. you don't need to maintain a server to\r\nreceive comments). Comments are stored in files in formats that can be\r\nprocessed by Pelican (e.g., Markdown, reStructuredText). Each comment resides\r\nin its own file.\r\n\r\nFeatures\r\n--------\r\n\r\n- Static comments for each article\r\n- Replies to comments\r\n- Avatars and `Identicons <https://en.wikipedia.org/wiki/Identicon>`__\r\n- Comment Atom feed for each article\r\n- Easily style-able via themes\r\n- Python 3 support\r\n\r\nSee it in action here:\r\n`bernhard.scheirle.de <http://bernhard.scheirle.de/posts/2014/March/29/static-comments-via-email/>`__\r\n\r\n+-------------------+-----------------------------+-----------------------------------------------+\r\n| Author | Website | Github |\r\n+===================+=============================+===============================================+\r\n| Bernhard Scheirle | http://bernhard.scheirle.de | https://github.com/Scheirle |\r\n+-------------------+-----------------------------+-----------------------------------------------+\r\n| William Minchin | https://blog.minchin.ca | https://github.com/MinchinWeb/blog.minchin.ca |\r\n+-------------------+-----------------------------+-----------------------------------------------+\r\n\r\nInstructions\r\n------------\r\n\r\n- `Quickstart Guide <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/quickstart.md>`__\r\n- `Installation and basic usage <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/installation.md>`__\r\n- `Import existing comments <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/import.md>`__\r\n- `Avatars and identicons <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/avatars.md>`__\r\n- `Comment Atom feed <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/feed.md>`__\r\n- `[Developer] How to do a release <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/docs/how-to-release.md>`__\r\n\r\nPyPi\r\n------------\r\nThe Pelican Comment System is now also in the Python Package Index and can\r\neasily installed via:\r\n\r\n::\r\n\r\n pip install minchin.pelican.plugins.static-comments\r\n\r\n\r\nRequirements\r\n------------\r\n\r\nPelican 3.4 or newer is required.\r\n\r\nTo create identicons, the Python Image Library is needed. Therefore you either\r\nneed PIL **or** Pillow (recommended). If you install the plugin from pip,\r\nPillow will automatically be installed.\r\n\r\n**Install Pillow manually via:**\r\n\r\n::\r\n\r\n pip install Pillow\r\n\r\nIf you don't want avatars or identicons, this plugin works fine without\r\nPIL/Pillow. You will, however, see a warning that identicons are deactivated\r\n(as expected).\r\n\r\nChange Log\r\n----------\r\n\r\nThe change log can be found in the `CHANGELOG.rst <https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments/blob/master/CHANGELOG.rst>`__\r\nfile.\r\n\r\n\r\nChange Log\r\n==========\r\n\r\nAll notable changes to this project will be documented in this file.\r\nThis project adheres to `Semantic Versioning <http://semver.org/>`__.\r\n\r\n2.1.2 - 2023-08-09\r\n------------------\r\n\\\r\n\r\nSupport\r\n~~~~~~~\r\n\r\n- blacklist ``autoloader`` v1.2.0\r\n\r\n\r\n2.1.1 - 2022-04-29\r\n------------------\r\n\\\r\n\r\nFixed\r\n~~~~~\r\n\r\n- Readme link targets\r\n\r\n\r\n2.1.0 - 2022-04-10\r\n------------------\r\n\\\r\n\r\nFixed\r\n~~~~~\r\n\r\n- generating slugs should now work across Pelican 3.7, 4.0-4.2, and 4.5+. The\r\n slugs should also match \"old\" versions (pre 2.0.0) of the plugin as well. Use\r\n the form `replyto: 1md` (no period for file extension start).\r\n\r\nAdded\r\n~~~~~\r\n\r\n- add prefix (\"[Static Comments]\") to all logging messages\r\n\r\n2.0.0 - 2022-04-08\r\n------------------\r\n\\\r\n\r\nFixed\r\n~~~~~\r\n\r\n- [**This is no longer the case with v2.1.0**.] the `replyto` field now takes the\r\n whole filename, rather than \"eating\" the dot in filenames. E.g. old:\r\n `replyto: 1md`; new: `replyto: 1.md`. You will need to update any comments\r\n that contain this field. If you don't update, a warning will appear when\r\n you generate your site.\r\n\r\nAdded\r\n~~~~~\r\n\r\n- automatically activates on Pelican 4.5+. If automatic loading isn't working,\r\n refer to the installation instructions for my `autoloader\r\n <https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader>`__ plugin.\r\n- Blogger comment exporter script is now available on the commandline as\r\n `blogger-comment-export`\r\n\r\nChanges\r\n~~~~~~~\r\n\r\n- move GitHub repo to `MinchinWeb/minchin.pelican.plugins.static-comments\r\n <https://github.com/MinchinWeb/minchin.pelican.plugins.static-comments>`__\r\n- plugin name, as listed in `PLUGINS` in `pelicanconf.py`, is now\r\n `minchin.pelican.plugin.static_comments`. Generally, though, the entry can be\r\n completely removed and instead rely on the auto-loading of plugins provided\r\n by Pelican 4.5+.\r\n\r\nUnresolved\r\n~~~~~~~~~~\r\n\r\n- documentation may (in places) still need to be updated\r\n\r\n\r\n1.4.0 - 2017-02-20\r\n------------------\r\n\\\r\n\r\nAdded\r\n~~~~~\r\n\r\n- add ``setup.py`` to allow posting plugin to PyPI `PR\r\n #862 <https://github.com/getpelican/pelican-plugins/pull/862>`__\r\n\r\n1.3.0 - 2017-01-10\r\n------------------\r\n\\\r\n\r\nAdded\r\n~~~~~\r\n\r\n- add\r\n `blogger\\_comment\\_export.py <import/blogger_comment_export.py>`__\r\n script to export comments from Blogger XML export and `associated\r\n documentation <docs/import.md>`__ `PR\r\n #835 <https://github.com/getpelican/pelican-plugins/pull/835>`__\r\n\r\n1.2.2 - 2016-12-19\r\n------------------\r\n\\\r\n\r\nFixed\r\n~~~~~\r\n\r\n- Correct jQuery expression in cancelReply method `PR\r\n #820 <https://github.com/getpelican/pelican-plugins/pull/820>`__\r\n\r\n1.2.1 - 2016-09-22\r\n------------------\r\n\\\r\n\r\nFixed\r\n~~~~~\r\n\r\n- Add support for the autoreload mode of pelican `PR\r\n #782 <https://github.com/getpelican/pelican-plugins/pull/782>`__\r\n `Fixes\r\n pelican#1949 <https://github.com/getpelican/pelican/issues/1949>`__\r\n\r\n1.2.0 - 2016-05-23\r\n------------------\r\n\\\r\n\r\nFixed - Documentation\r\n~~~~~~~~~~~~~~~~~~~~~\r\n\r\n- Correct template path `PR\r\n #713 <https://github.com/getpelican/pelican-plugins/pull/713>`__\r\n\r\nAdded - Documentation\r\n~~~~~~~~~~~~~~~~~~~~~\r\n\r\n- Adds Quickstart guide + default theme `PR\r\n #686 <https://github.com/getpelican/pelican-plugins/pull/686>`__\r\n\r\nFixed\r\n~~~~~\r\n\r\n- Fix mailto link: use '' instead of '' `PR\r\n #720 <https://github.com/getpelican/pelican-plugins/pull/720>`__\r\n- Fix comparison of offset-naive and offset-aware datetimes `PR\r\n #722 <https://github.com/getpelican/pelican-plugins/pull/722>`__\r\n\r\nAdded\r\n~~~~~\r\n\r\n- Logs a warning if the parent of a comment can not be found `PR\r\n #715 <https://github.com/getpelican/pelican-plugins/pull/715>`__\r\n\r\n1.1.0 - 2016-02-18\r\n------------------\r\n\\\r\n\r\nFixed - Documentation\r\n~~~~~~~~~~~~~~~~~~~~~\r\n\r\n- Updated old URLs `PR\r\n #677 <https://github.com/getpelican/pelican-plugins/pull/677>`__\r\n\r\nChanged\r\n~~~~~~~\r\n\r\n- Main logic runs a bit earlier (allows other plugins to access\r\n comments earlier) `PR\r\n #677 <https://github.com/getpelican/pelican-plugins/pull/677>`__\r\n- The writer to generate the feeds can now be exchanged (via a normal\r\n pelican writer plugin) `PR\r\n #677 <https://github.com/getpelican/pelican-plugins/pull/677>`__\r\n\r\n1.0.1 - 2015-10-04\r\n------------------\r\n\\\r\n\r\nFixed - Documentation\r\n~~~~~~~~~~~~~~~~~~~~~\r\n\r\n- Add commas indicating tuple (``PELICAN_COMMENT_SYSTEM_AUTHORS``) `PR\r\n #579 <https://github.com/getpelican/pelican-plugins/pull/579>`__\r\n\r\n1.0.0 - 2014-11-05\r\n------------------\r\n\\\r\n\r\nAdded\r\n~~~~~\r\n\r\n- Basic static comments\r\n- Atom Feeds\r\n- Replies to comments\r\n- Avatars and identicons\r\n\r\nThis change log uses `Keep a CHANGELOG <http://keepachangelog.com/>`__\r\nas a template.\r\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "A Pelican plugin, which allows you to add static comments to your articles.",
"version": "2.1.2",
"project_urls": {
"Homepage": "https://github.com/MinchinWeb/minchin.pelican.plugins.static_comments"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "988f2d546d3d7ca77a43b2c8640b4db6676a66d38c4d147879d76a73a7db2673",
"md5": "da40eedf175589fa416d6b52bdbda292",
"sha256": "dc0044582dc8dc081492313bb94bd7cc7e48d7edf9232c936988f16d46880a62"
},
"downloads": -1,
"filename": "minchin.pelican.plugins.static_comments-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da40eedf175589fa416d6b52bdbda292",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 28700,
"upload_time": "2023-08-09T20:12:37",
"upload_time_iso_8601": "2023-08-09T20:12:37.906828Z",
"url": "https://files.pythonhosted.org/packages/98/8f/2d546d3d7ca77a43b2c8640b4db6676a66d38c4d147879d76a73a7db2673/minchin.pelican.plugins.static_comments-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "23a1b40c2aba37b762b2714920a0f2ec961bcd5072ccdc7a986d4c8bef28eedd",
"md5": "539715a23eeaaf310450b5309dc75a86",
"sha256": "9b4a01e22d5edad8286f23465df815a9d0eb23c611b30adb58a96fca43e31f77"
},
"downloads": -1,
"filename": "minchin.pelican.plugins.static-comments-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "539715a23eeaaf310450b5309dc75a86",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31428,
"upload_time": "2023-08-09T20:12:03",
"upload_time_iso_8601": "2023-08-09T20:12:03.721954Z",
"url": "https://files.pythonhosted.org/packages/23/a1/b40c2aba37b762b2714920a0f2ec961bcd5072ccdc7a986d4c8bef28eedd/minchin.pelican.plugins.static-comments-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-09 20:12:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MinchinWeb",
"github_project": "minchin.pelican.plugins.static_comments",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "minchin.pelican.plugins.static-comments"
}
JSON
