A simple Django app that will give you a UserForeignKey model field.
Project description
Django UserForeignKey is a simple Django app (supporting Django 1.8 up to Django 2.0) that will give you a UserForeignKey model field. This field extends a regular ForeignKey model field, and has the option to automatically set the currently logged in user on insert and/or update.
Currently, Django 1.8, 1.11 (Python 2.7, Python 3.4+) and Django 2.0 (Python 3.4+) are supported.
Note: Django 1.9 and 1.10 should work too, but both versions are insecure and deprecated. Consider upgrading to a newer Django Version!
Quick start
Download and install using pip install
either from PyPi
pip install django-userforeignkey
or directly from this git repo if you prefer the development version from the master branch
pip install git+https://github.com/beachmachine/django-userforeignkey.git
Add django_userforeignkey to your INSTALLED_APPS setting like this:
INSTALLED_APPS = [
...
'django_userforeignkey',
]
Add django_userforeignkey.middleware.UserForeignKeyMiddleware to your MIDDLEWARE settings like this:
MIDDLEWARE = (
...
'django.contrib.auth.middleware.AuthenticationMiddleware',
...
'django_userforeignkey.middleware.UserForeignKeyMiddleware',
)
or if you are still using the an older Django version (e.g., Django 1.8) with MIDDLEWARE_CLASSES:
MIDDLEWARE_CLASSES = (
...
'django.contrib.auth.middleware.AuthenticationMiddleware',
...
'django_userforeignkey.middleware.UserForeignKeyMiddleware',
)
Make sure to insert the UserForeignKeyMiddleware middleware after AuthenticationMiddleware.
Example usage
Just add UserForeignKey to your model like you would with any other foreign key.
from django.db import models
from django_userforeignkey.models.fields import UserForeignKey
class MyModel(models.Model):
my_data = models.CharField(max_length=64, verbose_name="Very important data that are somehow related to a user")
user = UserForeignKey(auto_user_add=True, verbose_name="The user that is automatically assigned", related_name="mymodels")
- The UserForeignKey behaves just like a normal foreign key to the user model (using settings.AUTH_USER_MODEL), and thus also has properties such as related_name.
However, whenever an object is created by calling an authenticated view (admin, REST API, …) which contains a request.user object, the request.user object is automatically associated.
Configuration options
The configuration options are similar to Djangos DateField
auto_user Automatically sets the current user everytime the object is saved (e.g., created or updated). This is useful for last modified by information
auto_user_add Automatically sets the current user when the object is first created. This is useful for created by information
Changelog
0.2.1
Added setup.cfg with the license_file keyword, ensuring that the actual LICENSE file is also installed when using pip install
Improved .travis.yml
0.2.0
Tested for Django 2.0 support
Updated test app for Django 2.0 support
Updated tox and travis for automated tests with Django 2.0
Behaviour change: Prior to 0.2.0 the UserForeignKey field had editable set to False only if auto_user == True. Since 0.2.0 editable is set to False if auto_user == True or auto_user_add == True
0.1.2
Initial Release on PyPi
Development and Tests
git clone --recursive https://github.com/beachmachine/django-userforeignkey
cd django-userforeignkey
virtualenv -p python2 venv # or virtualenv -p python3
source venv/bin/activate
python setup.py install
pip install Django
cd tests/user_foreign_key_testapp
python manage.py test
You can also use tox for testing, as it will test against several Django and Python versions automatically. See tox.ini for details.
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
Hashes for django-userforeignkey-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0d990bdc2cac20c2338d5861ee1f8693577a599d26bf58c987422b283fde8bc |
|
MD5 | b352a17875a9ba441669a0703601523d |
|
BLAKE2b-256 | 4132cd86db9ddab4c16ca8cf1467354239aacea5a8001f660d385c3152ba03c0 |