django-qsessions 0.1.6

Comparison

Here is a brief comparison between Django’s session backends (db, cache, cached_db), django-user-sessions, and django-qsessions.

Requirements

Installation

Please note that if your system is in production and there are lots of active sessions using another session backend, you need to migrate them manually. We have no migration script.

1. First, make sure you’ve configured your cache. If you have multiple caches defined in CACHES, Django will use the default cache. To use another cache, set SESSION_CACHE_ALIAS to the name of that cache.

2. Install the latest version from PyPI:

   pip install django-qsessions

3. In settings:

   • In INSTALLED_APPS replace 'django.contrib.sessions' with 'qsessions'.

   • In MIDDLEWARE or MIDDLEWARE_CLASSES replace 'django.contrib.sessions.middleware.SessionMiddleware' with 'qsessions.middleware.SessionMiddleware'.

   • Set SESSION_ENGINE to 'qsessions.backends.cached_db'.

4. Run migrations to create qsessions.models.Session model.

   python manage.py migrate qsessions

For enabling location detection using GeoIP2 (session.location):

5. Install geoip2 package:

   pip install geoip2

6. Set GEOIP_PATH to a directory for storing GeoIP2 database.

7. Run the following command to download latest GeoIP2 database. You can add this command to a cron job to update GeoIP2 DB automatically.

   python manage.py download_geoip_db

Usage

django-qsessions has a custom Session model with following fields: user, user_agent, created_at, updated_at, ip.

Getting a user’s sessions:

user.session_set.filter(expire_date__gt=timezone.now())

Deleting a session:

# Deletes session from both DB and cache
session.delete()

Logout a user:

for session in user.session_set.all():
    session.delete()

Session creation time (user login time):

>>> session.created_at
datetime.datetime(2018, 6, 12, 17, 9, 17, 443909, tzinfo=<UTC>)

IP and user agent:

>>> session.ip
'127.0.0.1'
>>> session.user_agent
'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/65.0.3325.181 Safari/537.36'

And if you have configured GeoIP2, you can call .location():

>>> session.location()
'Tehran, Iran'

Admin page:

Why not django-user-sessions?

django-user-sessions has the same functionality, but it’s based on db backend. Using a cache will improve performance.

We got ideas and some codes from django-user-sessions. Many thanks to Bouke Haarsma for writing django-user-sessions.

TODO

• Write better documentation.

  • Explain how it works (in summary)

  • Add more details to existing documentation.

• Write more tests

• Performance benchmark (and compare with Django’s cached_db)

Contributions are welcome!

License

MIT