Requirements

• Python: 2.7, 3.3, 3.4, 3.5, 3.6

• Django: 1.10+

Setup

1. Add “online_users” to your INSTALLED_APPS

INSTALLED_APPS = [
    ...
    'online_users',
]

2. Add the OnlineNowMiddleware to your MIDDLEWARE_CLASSES after the SessionMiddleware

MIDDLEWARE_CLASSES = (
    ...
    'online_users.middleware.OnlineNowMiddleware',
)

3. Run python manage.py migrate to create the tables in the database.

Use

• The time of the last action for each user can be seen in the admin portal at http://127.0.0.1:8000/admin/online_users/onlineuser/

• To retrieve the current number of users online in the last 15 minutes

from datetime import timedelta
...
user_activity_objects = OnlineUserActivity.get_user_activities()
number_of_active_users = user_activity_objects.count()

• A timedelta can also be specified to the get_user_activities() with to find activity

from datetime import timedelta
...
user_activity_objects = OnlineUserActivity.get_user_activities(timedelta(minutes=60)
users = (user for user in user_activity_objects)

API

OnlineUserActivity holds two values: user, the user in question, and last_activity, a timestamp stored as a DateTimeField.

OnlineUserActivity.get_user_activities() will return OnlineUserActivity objects for the last 15 minutes by default. Developers can also pass in a time delta of a different length of time for the query. The response is a QuerySet containing the active users during that time period, and the items are sorted in descending chronological order.