django-popularity-mixin

Simple integration between django-cacheback and django-hitcount

Authored by Basil Shubin

Installation

First install the module, preferably in a virtual environment. It can be installed from PyPI:

pip install django-popularity-mixin

Setup

Make sure the project is configured for django-cacheback and django-hitcount.

Then add the following settings:

INSTALLED_APPS += (
    'popularity',
)

Usage

The popularity.views.PopularityMixin can be used to do the business-logic of counting the hits asynchronously by setting count_hit to True.

# views.py

from django.views.generic.detail import DetailView

from popularity.views import PopularityMixin


class CustomDetailView(PopularityMixin, DetailView):
    count_hit = True    # set to True if you want it to try and count the hit asynchronously
    template_name = "template.html"
    ...

The popularity.viwes.PopularityMixin extends Django’s generic django.views.generic.detail.DetailView and injects an additional context variable hitcount.

<!-- template.html -->

{# the primary key for the hitcount object #}
{{ hitcount.pk }}

{# the total hits for the object #}
{{ hitcount.total_hits }}

For a more granular approach to viewing the hits for a related object you can use the get_hit_count template tag.

{# remember to load the tags first #}
{% load popularity_tags %}

{# Return total hits for an object: #}
{% get_hit_count for [object] %}

{# Get total hits for an object as a specified variable: #}
{% get_hit_count for [object] as [var] %}

{# Get total hits for an object over a certain time period: #}
{% get_hit_count for [object] within ["days=1,minutes=30"] %}

{# Get total hits for an object over a certain time period as a variable: #}
{% get_hit_count for [object] within ["days=1,minutes=30"] as [var] %}

Please see example application. This application is used to manually test the functionalities of this package. This also serves as good example…

You need Django 1.8.1 or above to run that. It might run on older versions but that is not tested.