Metadata-Version: 2.0
Name: django-recommend
Version: 0.1.dev1
Summary: Generate recommendations in Django.
Home-page: https://github.com/dan-passaro/django-recommend
Author: Dan Passaro
Author-email: danpassaro@gmail.com
License: MIT
Platform: UNKNOWN
Requires-Dist: django
Requires-Dist: pyrecommend

django_recommend
================

.. image:: https://travis-ci.org/dan-passaro/django-recommend.svg
    :target: https://travis-ci.org/dan-passaro/django-recommend

Use ``pyrecommend`` in Django projects. 

.. warning:: not yet suitable for production.

``django_recommend/`` is the actual Django app intended for use in projects.

``simplerec/`` is a Django project used for testing.


Quickstart
----------

* Add ``django_recommend`` to your ``INSTALLED_APPS``, and run
  ``python manage.py migrate``.

* In your views, call ``django_recommend.set(user, object, score)`` to start
  recording user scores. (Currently this is assumed to be implicit feedback).

* In your templates, use ``{% load django_recommend %}`` and
  ``{{ obj|similar_objects }}`` to show similar objects to visitors. This
  filter returns a list, so you may also do, for example::

    {% with similar_products as product|similar_objects %}
        {% if similiar_products %}
            <h2>Other users also liked:</h2>
            <ul>
            {% for product in similar_products %}
                <li><a href="{{ product.get_absolute_url }}">{{ product }}</a></li>
            {% endfor %}
            </ul>
        {% endif %}
    {% endwith %}


