Skip to main content

Middleware to make user information always available.

Project description

travis-cli tests status for django-cuser PyPI Wheel PyPI Status PyPI License PyPI Format PyPI Py_versions PyPI Downloads PyPI Implementation PyPI Version PyPI Egg

Overview

cuser will bring you Current user of your django application from anywhere in your code. I know, sounds fantastic ;)

Supported Python versions

django-cuser currently can be run on multiple python versions:

  • Python 2 (2.7)

  • Python 3 (3.4, 3.5)

  • PyPy

Installing

django-cuser is also available at http://pypi.python.org/pypi/django-cuser So it can be install it by pip or easy_install:

$ pip install django-cuser

Or you can grab the latest version tarball:

$ python setup.py install

To enable django-cuser in your project

  • Add cuser to INSTALLED_APPS in your settings.py

  • Add cuser.middleware.CuserMiddleware to MIDDLEWARE_CLASSES after the authentication and session middleware.

Who is the current user

To set/get the user info, there is the following API:

from cuser.middleware import CuserMiddleware

Set the current user for this thread. Accepts user objects and login names:

CuserMiddleware.set_user(some_user)

Get the current user or None:

user = CuserMiddleware.get_user()

This will return some_user if there is no current user:

user = CuserMiddleware.get_user(some_user)

Forget the current user. It is always safe to call this, even if there is no current user:

CuserMiddleware.del_user()

The middleware automatically sets/deletes the current user for HTTP requests. For other uses (management commands, scripts), you will need to do this yourself.

CurrentUserField

cuser also provides a CurrentUserField, which can be used for auditing purposes. Use it as follows:

from cuser.fields import CurrentUserField

class MyModel(models.Model):
    ....
    creator = CurrentUserField(add_only=True, related_name="created_mymodels")
    last_editor = CurrentUserField(related_name="last_edited_mymodels")
    ...

This field is a ForeignKey to the settings.AUTH_USER_MODEL model and you can treat it as such.

Tests

django-cuser has been tested Django 1.8 and later. To run the the tests:

$ python run_tests.py

It’s also available on travis-ci:

https://travis-ci.org/Alir3z4/django-cuser/

Project details


Download files

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

Source Distribution

django-cuser-2016.5.29.tar.gz (6.1 kB view details)

Uploaded Source

File details

Details for the file django-cuser-2016.5.29.tar.gz.

File metadata

File hashes

Hashes for django-cuser-2016.5.29.tar.gz
Algorithm Hash digest
SHA256 c0c67323cbf1831e75a463534bbdba31f67a63aebc094333eb449f3d54f0c382
MD5 a9c14b0a9b32e6e9cf4a0921038c0b54
BLAKE2b-256 06440f1a91fd5a423b389c51d5627bb90485c91802142435dafc6c0d29c9079a

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page