Application which enables following features for users. Can be used for contact books or whatnot
django-follow enables your users to follow any model in your Django application.
pip install django-follow
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)
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
- Follow.objects.create(user, obj, **kwargs): Makes user follow obj
- Follow.objects.get_or_create(user, obj, **kwargs): Returns a tuple (Follow, bool)
- Follow.objects.is_following(user, obj): Returns bool
- Follow.objects.get_follows(model_or_object): Returns all the Follow objects associated with a certain model or object.
- 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
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.
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
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size django-follow-0.5.2.tar.gz (10.0 kB)||File type Source||Python version None||Upload date||Hashes View hashes|