Django sessions with a foreign key to the user
Project description
Django includes excellent built-in sessions, however all the data is hidden away into base64 encoded data. This makes it very difficult to run a query on all active sessions for a particular user. django-user-sessions fixes this and makes session objects a first class citizen like other ORM objects.
I would love to hear your feedback on this package. If you run into problems, please file an issue on GitHub, or contribute to the project by forking the repository and sending some pull requests. The package is translated into English, Dutch and other languages. Please contribute your own language using Transifex.
Also, have a look at the online example app, hosted by Heroku. It also contains the package django-two-factor-auth, but that application is not a dependency for this package. Also have a look at the bundled example templates and views to see how you can integrate the application into your project.
Compatible with Django 1.8, 1.10 and 1.11 on Python 2.7, 3.4 and 3.5. Documentation is available at readthedocs.org.
Features
To get the list of a user’s sessions:
user.session_set.filter(expire_date__gt=now())
Or logout the user everywhere:
user.session_set.all().delete()
The user’s IP address and user agent are also stored on the session. This allows to show a list of active sessions to the user in the admin:
And also in a custom layout:
Installation
pip install django-user-sessions
In INSTALLED_APPS replace 'django.contrib.sessions' with 'user_sessions'.
In MIDDLEWARE or MIDDLEWARE_CLASSES replace 'django.contrib.sessions.middleware.SessionMiddleware' with 'user_sessions.middleware.SessionMiddleware'.
Add SESSION_ENGINE = 'user_sessions.backends.db'.
Add url(r'', include('user_sessions.urls', 'user_sessions')), to your urls.py.
Make sure LOGOUT_REDIRECT_URL is set to some page to redirect users after logging out.
Run python manage.py syncdb (or migrate) and browse to /account/sessions/.
GeoIP
You need to setup GeoIP for the location detection to work. See the Django documentation on installing GeoIP. For Django versions 1.9 and newer, GeoIP2 should be used instead as GeoIP was deprecated in 1.9.
Getting help
For general questions regarding this package, please hop over to Stack Overflow. If you think there is an issue with this package; check if the issue is already listed (either open or closed), and file an issue if it’s not.
Development
How to contribute
Fork the repository on GitHub and start hacking.
Run the tests.
Send a pull request with your changes.
Provide a translation using Transifex.
Running tests
This project aims for full code-coverage, this means that your code should be well-tested. Also test branches for hardened code. You can run the full test suite with:
make test
Or run a specific test with:
make test TARGET=tests.tests.MiddlewareTest
For Python compatibility, tox is used. You can run the full test suite with:
tox
Releasing
The following actions are required to push a new version:
Update release notes
If any new translations strings were added, push the new source language to Transifex. Make sure translators have sufficient time to translate those new strings:
make tx-push
Add migrations:
python example/manage.py makemigrations user_sessions git commit user_sessions/migrations -m "Added migrations"
Update translations:
make tx-pull
Package and upload:
bumpversion [major|minor|patch] git push && git push --tags python setup.py sdist bdist_wheel twine upload dist/*
License
This project is licensed under the MIT license.
Credits
This library was written by Bouke Haarsma.
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.
Source Distribution
Built Distribution
File details
Details for the file django-user-sessions-1.5.3.tar.gz.
File metadata
- Download URL: django-user-sessions-1.5.3.tar.gz
- Upload date:
- Size: 20.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 985942b1385fb8db9a76a1e74d0c98317e0a0946e2c4725537f6f49ac03af970 |
|
| MD5 | dd760015eb4717f158edeafc0884e5ff |
|
| BLAKE2b-256 | 12cb80614f118d863f48aa7249c7d1d6010e5c21c3449172ee1f579716bdaa0f |
File details
Details for the file django_user_sessions-1.5.3-py2.py3-none-any.whl.
File metadata
- Download URL: django_user_sessions-1.5.3-py2.py3-none-any.whl
- Upload date:
- Size: 42.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b5b87fc5ece94528310de300316afaf5dd529c0ea19c655e774a1b4d0e3be852 |
|
| MD5 | 9323c0887033e1d9cefc639b95d68786 |
|
| BLAKE2b-256 | ca5eb22e832939f3e22af705e1de315e5eca2c2910caa149317f26aaf0a7d085 |
