Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

TurboGears2 pluggable application for comments to entities with facebook sharing

Project description

About tgcomments
-------------------------

tgcomments is a Pluggable Comments application for TurboGears2.
Comments can be added to any webpage by using the ``comments_for`` partial.

TGComments supports Facebook for avatar if the user logged using tgapp-fbauth
or if the User model provides a similar interface. Otherwise will fallback to
Gravatar.

Installing
-------------------------------

tgcomments can be installed both from pypi or from bitbucket::

pip install tgapp-tgcomments

should just work for most of the users

Plugging tgcomments
----------------------------

In your application *config/app_cfg.py* import **plug**::

from tgext.pluggable import plug

Then at the *end of the file* call plug with tgcomments::

plug(base_config, 'tgcomments')


To expose comments support for an entity, just call
the ``comments_for(entity)``  partial for
that entity inside your templates as explained in the
**Exposed Partials** section.

Exposed Partials
----------------------

tgcomments exposes a bunch of partials which can be used
to render pieces of the blogging system anywhere in your
application:

- ``tgcomments.partials:comments_for(entity)``
Given any SQLAlchemy or Ming entity (instance) which is available inside your application ``model`` module
it will display a list of comments for that entity with a box to add a new comment.

Provided Options
--------------------

tgcomments supports a bunch of options that can be passed to the plug call
to change its behavior:

- *notify_facebook* (default:True) automatically notify on facebook comments that
the user wrote if he has logged using Facebook
- *allow_anonymous* (default:True) allow anonymous users to comment

- *pretty_date* a function that will be used to properly format dates (example: "5 minutes ago")

- *get_user_avatar* a function that will be used to get the avatar (by default searches
for the ``avatar`` property, then fallbacks for fb information, then fallbacks gravatar)

Exposed Templates
--------------------

The templates used by registration and that can be replaced with
*tgext.pluggable.replace_template* are:

- ``tgcomments.templates.comments_partial``

Changelog
---------

- ``0.2.2`` - fixed anon comment creation broken by v0.2.1, used pre instead of div to
display the comment body, so it keeps newlines
- ``0.2.1`` - fixed ming relation with User and added author_username
- ``0.2.0`` - introduced compatibility with ming

Project details


Release history Release notifications

History Node

0.2.5

History Node

0.2.4

History Node

0.2.3

This version
History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.0

History Node

0.0.8

History Node

0.0.7

History Node

0.0.6

History Node

0.0.5

History Node

0.0.4

History Node

0.0.3

History Node

0.0.2

History Node

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
tgapp-tgcomments-0.2.2.tar.gz (11.1 kB) Copy SHA256 hash SHA256 Source None Mar 1, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page