A Django application that allows users to follow django model objects
Project description
The ``followit`` django app allows to easily set up a
capability for the site users to follow various things on the site,
represented by django model objects.
Setup
========
To the INSTALLED_APPS in your ``settings.py`` add entry ``'followit'``.
Then, in your apps' ``models.py``, probably at the end of the file, add::
import followit
followit.register(Thing)
Once that is done, in your shell run::
python manage.py syncdb
Not it will be possible for the user to follow instances of ``SomeModel``.
If you decide to allow following another model, just add another
``followit.register(...)`` statement to the ``models.py`` and re-run the ``syncdb``.
Usage
============
Examples below show how to use ``followit`` (assuming that model ``Thing``
is registered with ``followit`` in your ``models.py``::
bob.follow_thing(x)
bob.unfollow_thing(x)
things = bob.get_followed_things()
x_followers = x.get_followers()
Note that ``followit`` does not yet provide view functions of url routing
relevant to following or unfollowing items, nor template tags.
Available urls from the `followit/urls.py`::
/follow/<model_name>/<item_id>/
{% url follow_object "SomeModel" item_id %}
/unfollow/<model_name>/<item_id>/
{% url unfollow_object "SomeModel" item_id %}
``followit`` does not yet provide template tags.
capability for the site users to follow various things on the site,
represented by django model objects.
Setup
========
To the INSTALLED_APPS in your ``settings.py`` add entry ``'followit'``.
Then, in your apps' ``models.py``, probably at the end of the file, add::
import followit
followit.register(Thing)
Once that is done, in your shell run::
python manage.py syncdb
Not it will be possible for the user to follow instances of ``SomeModel``.
If you decide to allow following another model, just add another
``followit.register(...)`` statement to the ``models.py`` and re-run the ``syncdb``.
Usage
============
Examples below show how to use ``followit`` (assuming that model ``Thing``
is registered with ``followit`` in your ``models.py``::
bob.follow_thing(x)
bob.unfollow_thing(x)
things = bob.get_followed_things()
x_followers = x.get_followers()
Note that ``followit`` does not yet provide view functions of url routing
relevant to following or unfollowing items, nor template tags.
Available urls from the `followit/urls.py`::
/follow/<model_name>/<item_id>/
{% url follow_object "SomeModel" item_id %}
/unfollow/<model_name>/<item_id>/
{% url unfollow_object "SomeModel" item_id %}
``followit`` does not yet provide template tags.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-followit-0.0.4.tar.gz
(10.9 kB
view hashes)