API

Action Manager

class actstream.managers.ActionManager

Default manager for Actions, accessed through Action.objects

action_object(manager, *args, **kwargs)

Stream of most recent actions where obj is the action_object. Keyword arguments will be passed to Action.objects.filter

actor(manager, *args, **kwargs)

Stream of most recent actions where obj is the actor. Keyword arguments will be passed to Action.objects.filter

any(manager, *args, **kwargs)

Stream of most recent actions where obj is the actor OR target OR action_object.

model_actions(manager, *args, **kwargs)

Stream of most recent actions by any particular model

public(*args, **kwargs)

Only return public actions

target(manager, *args, **kwargs)

Stream of most recent actions where obj is the target. Keyword arguments will be passed to Action.objects.filter

user(manager, *args, **kwargs)

Stream of most recent actions by objects that the passed User obj is following.

Follow Manager

class actstream.managers.FollowManager

Manager for Follow model.

followers(actor)

Returns a list of User objects who are following the given actor (eg my followers).

following(user, *models)

Returns a list of actors that the given user is following (eg who im following). Items in the list can be of any model unless a list of restricted models are passed. Eg following(user, User) will only return users following the given user

for_object(instance)

Filter to a specific instance.

is_following(user, instance)

Check if a user is following an instance.

Views

actstream.views.respond(request, code)

Responds to the request with the given response code. If next is in the form, it will redirect instead.

actstream.views.follow_unfollow(request, *args, **kwargs)

Creates or deletes the follow relationship between request.user and the actor defined by content_type_id, object_id.

actstream.views.stream(request, *args, **kwargs)

Index page for authenticated user’s activity stream. (Eg: Your feed at github.com)

actstream.views.followers(request, content_type_id, object_id)

Creates a listing of User``s that follow the actor defined by ``content_type_id, object_id.

actstream.views.following(request, user_id)

Returns a list of actors that the user identified by user_id is following (eg who im following).

actstream.views.user(request, username)

User focused activity stream. (Eg: Profile page twitter.com/justquick)

actstream.views.detail(request, action_id)

Action detail view (pretty boring, mainly used for get_absolute_url)

actstream.views.actor(request, content_type_id, object_id)

Actor focused activity stream for actor defined by content_type_id, object_id.

actstream.views.model(request, content_type_id)

Actor focused activity stream for actor defined by content_type_id, object_id.

Feeds

class actstream.feeds.AbstractActivityStream

Abstract base class for all stream rendering. Supports hooks for fetching streams and formatting actions.

format(action)

Returns a formatted dictionary for the given action.

format_action_object(action)

Returns a formatted dictionary for the action object of the action.

format_actor(action)

Returns a formatted dictionary for the actor of the action.

format_item(action, item_type='actor')

Returns a formatted dictionary for an individual item based on the action and item_type.

format_target(action)

Returns a formatted dictionary for the target of the action.

get_object(*args, **kwargs)

Returns the object (eg user or actor) that the stream is for.

get_stream(*args, **kwargs)

Returns a stream method to use.

get_uri(action, obj=None, date=None)

Returns an RFC3987 IRI ID for the given object, action and date.

get_url(action, obj=None, domain=True)

Returns an RFC3987 IRI for a HTML representation of the given object, action. If domain is true, the current site’s domain will be added.

items(*args, **kwargs)

Returns a queryset of Actions to use based on the stream method and object.

Atom

Compatible with Atom Activity Streams 1.0 spec

class actstream.feeds.AtomUserActivityFeed

Atom feed of Activity for a given user (where actions are those that the given user follows).

class actstream.feeds.AtomModelActivityFeed

Atom feed of Activity for a given model (where actions involve the given model as any of the entities).

class actstream.feeds.AtomObjectActivityFeed

Atom feed of Activity for a given object (where actions involve the given object as any of the entities).

JSON

Compatible with JSON Activity Streams 1.0 spec

class actstream.feeds.AtomUserActivityFeed

Atom feed of Activity for a given user (where actions are those that the given user follows).

class actstream.feeds.AtomModelActivityFeed

Atom feed of Activity for a given model (where actions involve the given model as any of the entities).

class actstream.feeds.AtomObjectActivityFeed

Atom feed of Activity for a given object (where actions involve the given object as any of the entities).

Actions

actstream.actions.follow(user, obj, send_action=True, actor_only=True, **kwargs)

Creates a relationship allowing the object’s activities to appear in the user’s stream.

Returns the created Follow instance.

If send_action is True (the default) then a <user> started following <object> action signal is sent. Extra keyword arguments are passed to the action.send call.

If actor_only is True (the default) then only actions where the object is the actor will appear in the user’s activity stream. Set to False to also include actions where this object is the action_object or the target.

Example:

follow(request.user, group, actor_only=False)

actstream.actions.unfollow(user, obj, send_action=False)

Removes a “follow” relationship.

Set send_action to True (False is default) to also send a ``<user> stopped following <object> action signal.

Example:

unfollow(request.user, other_user)

actstream.actions.is_following(user, obj)

Checks if a “follow” relationship exists.

Returns True if exists, False otherwise.

Example:

is_following(request.user, group)

actstream.actions.action_handler(verb, **kwargs)

Handler function to create Action instance upon action signal call.

Decorators

actstream.decorators.stream(func)

Stream decorator to be applied to methods of an ActionManager subclass

Syntax:

from actstream.decorators import stream
from actstream.managers import ActionManager

class MyManager(ActionManager):
    @stream
    def foobar(self, ...):
        ...

Templatetags

Start off your templates by adding:

{% load activity_tags %}

actstream.templatetags.activity_tags.activity_stream(context, stream_type, *args, **kwargs)

Renders an activity stream as a list into the template’s context. Streams loaded by stream_type can be the default ones (eg user, actor, etc.) or a user defined stream. Extra args/kwargs are passed into the stream call.

{% activity_stream 'actor' user %}
{% for action in stream %}
    {% display_action action %}
{% endfor %}

actstream.templatetags.activity_tags.is_following(user, actor)

Returns true if the given user is following the actor

{% if request.user|is_following:another_user %}
    You are already following {{ another_user }}
{% endif %}

actstream.templatetags.activity_tags.display_action(parser, token)

Renders the template for the action description

{% display_action action %}

actstream.templatetags.activity_tags.follow_url(parser, token)

Renders the URL of the follow view for a particular actor instance

<a href="{% follow_url other_user %}">
    {% if request.user|is_following:other_user %}
        stop following
    {% else %}
        follow
    {% endif %}
</a>

actstream.templatetags.activity_tags.follow_all_url(parser, token)

Renders the URL to follow an object as both actor and target

<a href="{% follow_all_url other_user %}">
    {% if request.user|is_following:other_user %}
        stop following
    {% else %}
        follow
    {% endif %}
</a>

actstream.templatetags.activity_tags.actor_url(parser, token)

Renders the URL for a particular actor instance

<a href="{% actor_url request.user %}">View your actions</a>
<a href="{% actor_url another_user %}">{{ another_user }}'s actions</a>