{
"info": {
"author": "AXANT",
"author_email": "tech@axant.it",
"bugtrack_url": null,
"classifiers": [],
"description": "About activitystream\n--------------------\n\nactivitystream is a Pluggable application for TurboGears2 for create a simple activity stream.\n\nThe activity stream is intended to be used as base layer for a **notification** system\n\nCurrently this pluggable works only with **ming** fell free to submit a pull request with *sqlalchemy* support\n\nInstalling\n----------\n\nactivitystream can be installed both from pypi or from github::\n\n pip install activitystream\n\nshould just work for most of the users\n\nPlugging activitystream\n-----------------------\n\nIn your application *config/app_cfg.py* import **plug**::\n\n from tgext.pluggable import plug\n\nThen at the *end of the file* call plug with activitystream::\n\n plug(base_config, 'activitystream')\n\n\nActionManager\n-------------\n\nWhen you want to create an activity you should do something like::\n\n from activitystream import ActionManager\n am = ActionManager()\n\n activity = am.create(\n actor=model.User.query.find().all()[0],\n verb='created',\n target=model.Post.query.find().all()[0],\n recipients=model.User.query.find().all()[1:3],\n )\n\nThen you may want to notify the activity to the recipients.\nIt's up to you to choose how to dispatch them.\n\nFields Explanation\n-------------------\n\n- **actor**: reference to who is creating the activity\n- **verb**: a string describing the action itself, for example 'created' or 'updated'\n- **action_obj**: reference to ... I don't know\n- **target**: reference to the subject of the activity\n- **timestamp**: datetime of the creation of the activity\n- **description**: string with a description of the activity\n- **extra**: string that you can use for example to store a json with extra informations\n- **recipients**: list of references to who is expected to receive\n a notification from this activity. references can be of different entities.\n\nNot Seen (counter of unread notifications)\n------------------------------------------\n\nAdd in your recipient model (probably your User model)::\n\n from datetime import datetime\n last_activity_seen = FieldProperty(s.DateTime, if_missing=datetime.utcnow())\n\nthen you can get the latest 10 notifications of a recipient with::\n\n recipient = model.User.query.find().all()[1]\n actions = am.get_by_recipient(recipient).limit(10).all()\n # and if you want a counter of unread notifications call\n count = am.count_not_seen_by_recipient(recipient)\n # you can check if the recipient have seen a notification with\n not_seen = actions[0].timestamp > recipient.last_activity_seen\n # don't forget to update your recipient when him reads his notifications\n recipient.last_activity_seen = datetime.utcnow()\n\nExposed Controllers\n-------------------\n\nif you don't like your urls to start with activitystream just ``plug`` with a new app_id\n\n- **/activitystream/ajax_update_last_seen_of_a_recipient**: call this through ajax with ``_type``\n and ``_id`` of the recipient to update ``last_activity_seen``.\n should return a json with the last_activity_seen before the update\n\n- **/activitystream/see**: updates ``last_activity_seen`` of the logged in user\n and redirects to the given ``target_link``\n\nNotifications Rendering\n-----------------------\n\nThis is up to you. I suggest to use ``tg.render_template`` with ``tg_cache``\n\nadding in ``myproject.lib.helpers``::\n\n from activitystream import am\n from tg import render_template\n def notification_cache(n):\n return {\n 'cache_key': n._id, # this is really important\n 'cache_expire': 604800, # a week\n 'cache_type': 'memory',\n }\n\n\nand in the template where you want your notifications to being displayed::\n\n \n
${h.render_template(\n {'n': n, 'tg_cache': h.notification_cache(n)},\n 'kajiki',\n 'myproject.templates.notification'\n )}
\n \n\nmeanwhile your ``myproject.templates.notification`` may look like::\n\n \n \n