Extends Django's cached_db session backend
Project description
django-qsessions is a session backend for Django that extends Django’s cached_db session backend and Session model to add following features:
Sessions have a foreign key to User
Sessions store IP and User Agent
Comparison
Here is a brief comparison between Django’s session backends (db, cache, cached_db), django-user-sessions, and django-qsessions.
db |
cache |
cached_db |
django-user-sessions |
django-qsessions |
|
|---|---|---|---|---|---|
Better Performance |
✔✔ |
✔ |
✔ |
||
Persistent |
✔ |
✔ |
✔ |
✔ |
|
Query by User |
✔ |
✔ |
|||
Store IP and User Agent |
✔ |
✔ |
Requirements
Python version |
Django versions |
|---|---|
3.6 |
2.0, 1.11, 1.10 |
3.5 |
2.0, 1.11, 1.10 |
3.4 |
2.0, 1.11, 1.10 |
2.7 |
1.11, 1.10 |
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 sessions manually.
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.
Install the latest version from PyPI:
pip install django-qsessionsIn 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'.
Run migrations to create qsessions.models.Session model.
python manage.py migrate qsessions
For enabling location detection using GeoIP2 (session.location):
Install geoip2 package:
pip install geoip2Set GEOIP_PATH to a directory for storing GeoIP2 database.
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
For clearing expired sessions from DB, run python manage.py clearsessions. It’s recommended to add it to a daily cron job.
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)
Explain how to query sessions based on users, and delete sessions
Add more details to existing documentation.
Write more tests
Performance benchmark (and compare with Django’s cached_db)
Contributions are welcome!
License
MIT
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
