django-currentuser
Advanced tools
.. contents:: Conveniently store reference to request user on thread/db level.
Install django-currentuser::
pip install django-currentuser
Note: if there is a new Django version released that the library hasn't been upgraded to support yet, e.g.:
The conflict is caused by:
The user requested django==5.1
django-currentuser 0.8.0 depends on Django<5.1 and >=4.2
you can try to install it with the unsupported/untested Django version by
using the DJANGO_CURRENTUSER_USE_UNSUPPORTED_DJANGO environment variable
DJANGO_CURRENTUSER_USE_UNSUPPORTED_DJANGO=1 pip install django-currentuser
Ade it to the middleware classes in your settings.py::
MIDDLEWARE = (
...,
'django_currentuser.middleware.ThreadLocalUserMiddleware',
)
Then use it in a project::
from django_currentuser.middleware import (
get_current_user, get_current_authenticated_user)
# As model field:
from django_currentuser.db.models import CurrentUserField
class Foo(models.Model):
created_by = CurrentUserField()
updated_by = CurrentUserField(on_update=True)
Both libraries serve the same purpose, but be aware of these differences (as of django-cuser v.2017.3.16):
django-currentuser's CurrentUserField stores the reference to the request user at initialization of the model instance and still allows you to overwrite the value before saving. django-cuser sets the value in the pre_save handler of the field just before writing it to the database. Intermediate changes will be ignored.
django-cuser deletes the user reference from the thread after finishing a response and it will therefore no longer be available for testing purposes.
Note on semver: While the fact that Django support stopped for version
X, doesn't have to mean it's a breaking change for this lib, as it would be just a
backward-compatible metadata patch, no code change. However, at some point support needs to be
dropped - so for simplicity, the project follows what Django supports. If someone needs to use
different, unsupported version, DJANGO_CURRENTUSER_USE_UNSUPPORTED_DJANGO allows for it.
0.10.0
0.9.0
0.8.0
DJANGO_CURRENTUSER_USE_UNSUPPORTED_DJANGO environment variable
to make upgrades easier0.7.0
0.6.1
0.6.0
0.5.3 - add support for Django 3.2 and Python 3.9
0.5.2 - Fixed Django deprecation warning about using ugettext_lazy()
0.5.1 - add support for Django 3.1 and Python 3.8
0.5.0
0.4.3 - add support for Django 3.0
0.4.2 - Minor fix for supported Django and Python versions
0.4.0 - update supported versions
0.3.4 - Use public Travis for packaging to remove dependency on outdated build system
0.3.3 - drop Python 3.7 support due to build process problems
0.3.1 - attempt to add Python 3.7 support
0.3.0 - update supported versions according to https://www.djangoproject.com/download/#supported-versions and https://devguide.python.org/#status-of-python-branches
0.2.3 - support custom user model, drop Django 1.10 support
0.2.2 - support Django 2.0
0.2.1 - version fixes #9
0.2.0 - New middleclass format
0.1.1 - minor release
0.1.0 - initial release
official django docs <https://docs.djangoproject.com/en/dev/faq/install/#what-python-version-can-i-use-with-django>_.. contributing start
As an open source project, we welcome contributions.
The code lives on github <https://github.com/zsoldosp/django-currentuser>_.
Reporting issues/improvements
Please open an `issue on github <https://github.com/zsoldosp/django-currentuser/issues/>`_
or provide a `pull request <https://github.com/zsoldosp/django-currentuser/pulls/>`_
whether for code or for the documentation.
For non-trivial changes, we kindly ask you to open an issue, as it might be rejected.
However, if the diff of a pull request better illustrates the point, feel free to make
it a pull request anyway.
Pull Requests
~~~~~~~~~~~~~
* for code changes
* it must have tests covering the change. You might be asked to cover missing scenarios
* the latest ``flake8`` will be run and shouldn't produce any warning
* if the change is significant enough, documentation has to be provided
To trigger the packaging, run `make release` on the master branch with a changed
version number.
Setting up all Python versions
::
sudo apt-get -y install software-properties-common
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
for version in 3.10 3.11 3.12 3.13 3.14; do
py=python$version
if ! which ${py}; then
sudo apt-get -y install ${py} ${py}-dev
fi
done
sudo add-apt-repository --remove ppa:deadsnakes/ppa
sudo apt-get update
Code of Conduct
As it is a Django extension, it follows
`Django's own Code of Conduct <https://www.djangoproject.com/conduct/>`_.
As there is no mailing list yet, please use `github issues`_
Contributors
~~~~~~~~~~~~
Current maintainer: @zsoldosp
Initial development & maintenance: @PaesslerAG
For contributors, see `github contributors`_.
.. contributing end
.. _github contributors: https://github.com/zsoldosp/django-currentuser/graphs/contributors
.. _github issues: https://github.com/zsoldosp/django-currentuser/issues
FAQs
Conveniently store reference to request user on thread/db level.
We found that django-currentuser demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Socket uncovered four malicious NuGet packages targeting ASP.NET apps, using a typosquatted dropper and localhost proxy to steal Identity data and backdoor apps.
Research
An emerging npm supply chain attack that infects repos, steals CI secrets, and targets developer AI toolchains for further compromise.
Company News
Socket is proud to join the OpenJS Foundation as a Silver Member, deepening our commitment to the long-term health and security of the JavaScript ecosystem.