Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Conveniently store reference to request user on thread/db level.

Project description

https://travis-ci.org/PaesslerAG/django-currentuser.svg?branch=master

Quickstart

Install django-currentuser:

pip install django-currentuser

Add 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()

Differences to django-cuser

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.

Release Notes

  • 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
    • support Django 1.11.x and not just 1.11.0
  • 0.2.0 - New middleclass format - Adapt to new object based middle class format of Django 1.10+ - Drop support for deprecated Django versions 1.8 and 1.9
  • 0.1.1 - minor release
    • suppress warning for passed kwargs as long as they match the defaults (avoids them being printed during running tests when fields are cloned)
  • 0.1.0 - initial release
    • provides middleware + methods to set + retrieve reference of currently logged in user from thread
    • provides CurrentUserField that by default stores the currently logged in user
    • supports Django 1.10, 1.11 on python 2.7, 3.4, 3.5, and 3.6 - as per the official django docs

Contributing

As an open source project, we welcome contributions.

The code lives on github.

Reporting issues/improvements

Please open an issue on github or provide a pull request 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

Setting up all Python versions

sudo apt-get -y install software-properties-common
sudo add-apt-repository ppa:fkrull/deadsnakes
sudo apt-get update
for version in 3.4 3.5 3.6; do
  py=python$version
  sudo apt-get -y install ${py} ${py}-dev
done

Code of Conduct

As it is a Django extension, it follows Django’s own Code of Conduct. As there is no mailing list yet, please just email one of the main authors (see setup.py file or github contributors)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_currentuser-0.2.3-py2.py3-none-any.whl (7.9 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jun 28, 2018
django-currentuser-0.2.3.tar.gz (5.6 kB) Copy SHA256 hash SHA256 Source None Jun 28, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page