Installation¶
Get the code¶
Installation is easy using pip and the only requirement is a recent version of Django.
$ pip install django-activity-stream
or get it from source
$ pip install git+https://github.com/justquick/django-activity-stream.git#egg=actstream
Basic app configuration¶
Then to add the Django Activity Stream to your project add the app actstream to your INSTALLED_APPS and urlconf.
INSTALLED_APPS = (
'django.contrib.auth',
...
'actstream'
)
Warning
In Django versions older than 1.7, the app must be placed somewhere after all the apps that are going to be generating activities (eg django.contrib.auth). The safest thing to do is to have it as the last app in INSTALLED_APPS.
Add the activity urls to your urlconf
urlpatterns = patterns('',
...
('^activity/', include('actstream.urls')),
...
)
The activity urls are not required for basic usage but provide activity Feeds and handle following, unfollowing and querying of followers.
Migrations¶
As of Django 1.7 and later, the core ships with an integrated migrations framework based on South migrations.
Note
In django-activity-streams 0.6.0 and later the migrations have been re-initialized with the newer migrations framework and the south migrations have been deprecated.
If you still wish to use the south migrations there is a way. Install it as you would normally and then modify your settings to use the deprecated south migration modules in actstream.
SOUTH_MIGRATION_MODULES = {
'actstream': 'actstream.south_migrations',
}
Add extra data to actions¶
If you want to use custom data on your actions, then make sure you have django-jsonfield installed
$ pip install django-jsonfield
You can learn more at Adding Custom Data to your Actions
Supported Environments¶
The following Python/Django versions and database configurations have been tested to work with the latest version of django-activity-stream.
- PostgreSQL 9.1, 9.2 and 9.3
- Psy = psycopg2 2.6
- PCffi = psycopg2cffi 2.6.1
- MySQL 5.5 and 5.6
- My = MySQL-python 1.2.5
- PyMy = PyMySQL 0.6.6
- S = Sqlite 3.7
Py 2.6 | Py 2.7 | Py 3.2 | Py 3.3 | Py 3.4 | PyPy 2 | PyPy 3 | |
---|---|---|---|---|---|---|---|
Django 1.4 | Psy/My/S | Psy/My/S | PCffi/My/S | ||||
Django 1.5-1.8 | Psy/My/S | Psy/My/S | Psy/PyMy/S | Psy/PyMy/S | Psy/PyMy/S | PCffi/My/S | My/S |