django-groups-cache 0.3.1

Caches the groups a user is in so requests don't have to make calls to the database to check group status.

Caches the groups a user is in so requests don’t have to make calls to the database to check group status.

Documentation

The full documentation is at https://django-groups-cache.readthedocs.io.

Quickstart

Install django-groups-cache:

pip install django-groups-cache

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'groups_cache.apps.GroupsCacheConfig',
    ...
)

Add the middleware to your MIDDLEWARE_CLASSES:

MIDDLEWARE_CLASSES = (
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    ...
    'groups_cache.middleware.GroupsCacheMiddleware',
)

Features

• Adds groups_cache property to request object

• Provides templatetag has_group

• Invalidates cache on User or Group model changes

Checking in a Django Template if the user is in a group name:

{% if "admins" in request.groups_cache %}
  <a href="/admin">Admin Panel</a>
{% endif %}

# or use templatetag, note that templatetag is slower

{% load has_group %}

{% if request.user|has_group:"admins" %}
  <a href="/admin">Admin Panel</a>
{% endif %}

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

• Cookiecutter

• cookiecutter-djangopackage

History

0.3.1 (2017-01-11)

• Documentation updates

0.3.0 (2017-01-11)

• First stable and working release on PyPI.

0.1.0 (2017-01-11)

• First release on PyPI.