Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Tree: 6126fc34a9
Fetching contributors…

Cannot retrieve contributors at this time

130 lines (75 sloc) 3.61 KB


django-stream provides activity streams for Django applications.

It differs from django-activity-stream in that it does not use generic relations and does not provide a Follow object, but it can be used together with django-follow.

The motivation to not use generic relations is to cut down on SQL queries and make it nice and simple to do cross table joins.


pip install django-stream


  • In your add stream types:

    INSTALLED_APPS += ('stream', )
        ('default', 'Stream Item'),
        ('edit', 'Object edited'),
        ('created','Object created'),
        ('deleted','Object deleted'),
        ('followed', 'Object followed'),
  • Register the models you want to be able to tag in your streams:

    from django.db import models
    from stream import utils
    class MyModel(models.Model):
        field = models.CharField(max_length = 255)


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

Clone the repository and cd into the project folder:

cd test_project/
python test stream



  • ActionManager.create(actor, verb, target=None, action_object=None, **kwargs):
    Create a new action object

  • ActionManager.get_or_create(actor, verb, target=None, action_object=None, **kwargs) :
    Returns a tuple (Action, bool)

  • ActionManager.get_for_actor(actor):
    Returns all the Action objects involving actor

  • ActionManager.get_for_actors(actors):
    Similar to above, but acts on a list of actors

  • ActionManager.get_for_target(target):
    Returns all the Action objects involving target

  • ActionManager.get_for_targets(targets):
    Similar to above, but acts on a list of targets

  • ActionManager.get_for_action_object(obj):
    Returns all the Action objects involving obj

  • ActionManager.get_for_action_objects(objects):
    Similar to above, but acts on a list of action objects.


The generated fields on the Action model follow a simple pattern:


Meaning, if you've registered the User model as actor target and as action object, you could run custom queries like this:

Action.objects.filter(actor_user = User.objects.filter(username__startswith = 'a'))
Action.objects.filter(target_user = User.objects.filter(username__startswith = 'b'))
Action.objects.filter(action_object_user = User.objects.filter(username__startswith = 'c'))


  • stream.utils.register_actor(Model):
    Make Model a possible actor

  • stream.utils.register_target(Model):
    Make Model a possible target

  • stream.utils.register_acction_object(Model):
    Make Model a possible action_object

  • stream.utils.action.send(actor, verb, target=None, action_object=None, description=None):
    Create a new action object

Template Tags

There is one template tag that attempts to render a given action:

{% load stream_tags %}
{% render_action action %}

The template tag will try to find stream/<action.verb>.html and if it fails render the default template stream/action.html.


There is one signal that is fired when new actions are created:



Jump to Line
Something went wrong with that request. Please try again.