Skip to content
This repository has been archived by the owner on Oct 23, 2023. It is now read-only.

Latest commit

 

History

History
28 lines (18 loc) · 1.45 KB

README.rst

File metadata and controls

28 lines (18 loc) · 1.45 KB
Raw

Activity Stream Documentation

Authors: Justin Quick <[email protected]> and many others listed in AUTHORS.txt
Version: 0.4.4
 
pip install django-activity-stream==0.4.4

Django Activity Stream is a way of creating activities generated by the actions on your site. Action events are categorized by four main components.

  • Actor. The object that performed the activity.
  • Verb. The verb phrase that identifies the action of the activity.
  • Action Object. (Optional) The object linked to the action itself.
  • Target. (Optional) The object to which the activity was performed.

Actor, Action Object and Target are GenericForeignKeys to any arbitrary Django object. An action is a description of an action that was performed (Verb) at some instant in time by some Actor on some optional Target that results in an Action Object getting created/updated/deleted.

For example: justquick (actor) closed (verb) issue 2 (object) on activity-stream (target) 12 hours ago

Nomenclature of this specification is based on the Activity Streams Spec: http://activitystrea.ms/specs/atom/1.0/

For complete documenation see Django Activity Stream Documentation