django-whoshere 0.1.6.2

Requirements

• Django >= 1.7

• requests

Installation

• Make sure you have Django’s Cache backend set up.

• Install using pip: pip install django-whoshere

• Add django_whoshere to INSTALLED_APPS in settings.py:

  INSTALLED_APPS = (
      # other apps
      'django_whoshere',
  )

• Add django_whoshere.middelware.TrackMiddleware to your MIDDLEWARE_CLASSES. Make sure it comes after your Authentication middleware.

MIDDLEWARE_CLASSES = (
    # other middleware
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
    'django_whoshere.middleware.TrackMiddleware',
   # more middleware
)

Configuration

No configuration is needed but these settings are provided for convenience:

• WHOSHERE_TIMEOUT = 300 Sets the timeout for user activity. Defaults to 300 seconds.

• WHOSHERE_LABEL = 'Active Users' Overrides the admin link label. Defaults to ‘Active Users’

• WHOSHERE_PREFIX = 'whoshere' Prefix used in cache keys. Defaults to ‘whoshere’.

• WHOSHERE_TELIZE = True You can set this to ‘False’ to turn off geolocation lookups with Telize. Is always off if GeoIp is installed.

Template tags

Besides the admin interface, WhosHere’s functions are also available as template tags:

{% load whoshere %}

There are now {% active_user_count %} users logged in.

{% active_users as users %}
<ul>
{% for user in users %}
   <li>{{ user.username }} ({{ user.email }})</li>
{% endfor %}
</ul>

<p>Your IP address is {% your_ip %}</p>
<p>Your browser and platform is {% your_agent %}</p>
<p>You live in {% your_city %}, {% your_country %}</p>

Geolocation

Originally this plugin started with GeoIP support only, but this means you have to install the rather large database that it comes with. Not a problem if you already use it for other things, but not a lightweight solution if you only use it for WhosHere. As an alternative WhosHere uses the free Telize API over HTTPS by default to find the location of your logged in users. This comes with some caveats:

• The Telize API is opensource, but you are sending users IP addresses, albeit anonymously, to a third party.

• Being a free API it can sometimes be unavailable or slow

• Your server needs HTTPS access to a remote location

You can turn off Telize lookups with WHOSHERE_TELIZE = False in your settings.py or by installing and configuring GeoIP.

Notes

• Middleware is kept as small as possible and only adds IP and User Agent to the cache for the current logged in user.

• No database tables are used. Instead WhosHere uses a proxy model of the User model.

• Proxy models will create migrations but do not affect your database

• Telize lookups are cached for performance

• Using the excellent requests library for better SSL support

Todo

• Add tests

• Think of other things to add