Skip to main content

Application which enables following features for users. Can be used for contact books or whatnot

Project description

django-follow
=============

django-follow enables your users to follow any model in your Django
application.

Installation:
-------------

::

pip install django-follow

Usage:
------

- Add ``follow`` to your ``INSTALLED_APPS``
- Include ``follow.urls`` into your URLs if you plan on using the
views:

::

urlpatterns = patterns('',
url('^', include('follow.urls')),
)

- Register the models you want to be able to follow in your
``models.py`` files:

::

from django.db import models
from follow import utils

class MyModel(models.Model):
field = models.CharField(max_length = 255)


utils.register(MyModel)

Test
----

The repository includes a sample project and application that is
configured to test ``django-follow``.

Clone the repository and cd into the project folder:

::

cd test_project/
python manage.py test follow

API
---

Manager
~~~~~~~

- ``FollowManager.create(user, obj, **kwargs)``:
Makes ``user`` follow ``obj``

- ``FollowManager.get_or_create(user, obj, **kwargs)``:
Returns a tuple ``(Follow, bool)``

- ``FollowManager.is_following(user, obj)``:
Returns ``bool``

- ``FollowManager.get_follows(model_or_object)``:
Returns all the ``Follow`` objects associated with a certain model
or object.

Utils
~~~~~

- ``follow.utils.register(model, field_name, related_name, lookup_method_name)``:
Registers ``model`` to django-follow.

- ``follow.utils.follow(user, object)``:
Makes ``user`` follow ``object``

- ``follow.utils.unfollow(user, object)``:
Makes ``user`` unfollow ``object``

- ``follow.utils.follow_url(user, object)``:
Returns the right follow/unfollow URL for ``user`` and ``object``

- ``follow.utils.follow_link(object)``:
Returns the following URL for ``object``

- ``follow.utils.unfollow_link(object)``:
Returns the unfollowing URL for ``object``

Template Tags
~~~~~~~~~~~~~

django-follow ships a template tag that creates urls, a filter to check
if a user follows an object and a template tag to render the follow
form.

::

{% load follow_tags %}
{% follow_url object %}
{% request.user|is_following:object %}
{% follow_form object %}
{% follow_form object "your/custom/template.html" %}

- ``{% follow_url object %}``:
Returns the URL to either follow or unfollow the object, depending
on whether ``request.user`` is already following the object.

- ``{% follow_url object other_user %}``:
Same as above - but instead of resolving for ``request.user`` it
resolves for any user you pass in.

- ``{% request.user|is_following:object %}``:
Returns ``True``/``False`` if the user follows / does not follow the
object.

- ``{% follow_form object %}``:
Renders a form to follow a given object.

- \`{% follow\_form object "your/custom/template.html" %}:
Renders the form with a custom template.

Signals
~~~~~~~

django-follow provides two signals:

- ``follow.signals.followed(sender, user, target, instance)``
- ``follow.signals.unfollowed(sender, user, target, instance)``

To invoke a handler every time a ``User`` or ``Group`` object is
followed, do something along these lines:

::

from django.contrib.auth.models import User
from follow import signals

def user_follow_handler(user, target, instance, **kwargs):
send_mail("You were followed", "You have been followed", "no-reply@localhost", [target.email])

def group_follow_handler(user, target, instance, **kwargs):
send_mail("Group followed", "%s has followed your group" % user, "no-reply@localhost", [[u.email for u in target.user_set.all()]])

signals.followed.connect(user_follow_handler, sender = User, dispatch_uid = 'follow.user')
signals.followed.connect(group_follow_handler, sender = Group, dispatch_uid = 'follow.group')

This works vica versa with the unfollowed handler too.

Release Notes
-------------

v0.5 - *BACKWARDS INCOMPATIBLE*

- The follow and unfollow views now only accept POST requests

v0.4 - *BACKWARDS INCOMPATIBLE*

- Made the manager *a lot* lighter.
- Removed ``Model.followers`` method
- Added ``Model.get_follows`` method returning all the ``Follow``
objects
- Moved ``Follow.follower`` to ``Follow.user``
- Replaced ``Follow.get_object`` method with read/writable
``Follow.target`` property
- ``follow.util`` moved to ``follow.utils``
- No more M2M following

--------------

`@flashingpumpkin <http://twitter.com/flashingpumpkin>`_

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-follow-0.5.1.tar.gz (10.0 kB view details)

Uploaded Source

File details

Details for the file django-follow-0.5.1.tar.gz.

File metadata

  • Download URL: django-follow-0.5.1.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-follow-0.5.1.tar.gz
Algorithm Hash digest
SHA256 8ab2f553d3008b29ea3fd08e06a27d6c05962a5cbabd7b923679258378c0c8b9
MD5 650f860da47f81357ad89dbc821b56e2
BLAKE2b-256 5905b63c27165e2cda63030676daeafe7b05adbc5cb2aa007bed2deaf3a3d277

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page