https://github.com/audiolion/django-groups-cache

Cache django user groups for fast checking!
https://github.com/audiolion/django-groups-cache

cache django groups

Last synced: 12 months ago
JSON representation

Cache django user groups for fast checking!

• Host: GitHub
• URL: https://github.com/audiolion/django-groups-cache
• Owner: audiolion
• License: mit
• Created: 2017-01-11T18:50:45.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-07-15T18:41:00.000Z (over 3 years ago)
• Last Synced: 2025-04-15T13:44:47.173Z (12 months ago)
• Topics: cache, django, groups
• Language: Python
• Homepage:
• Size: 45.9 KB
• Stars: 7
• Watchers: 0
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
=============================

django-groups-cache

=============================

.. image:: https://badge.fury.io/py/django-groups-cache.svg

    :target: https://badge.fury.io/py/django-groups-cache

.. image:: https://travis-ci.org/audiolion/django-groups-cache.svg?branch=master

    :target: https://travis-ci.org/audiolion/django-groups-cache

.. image:: https://codecov.io/gh/audiolion/django-groups-cache/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/audiolion/django-groups-cache

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

Support

-------

Currently supporting Django 1.8, 1.11, and 2.0 with Python 2.7/Python 3 where support for versions aligns with

Django's support. See the `tox.ini` file for specific Python and Django version pairings.

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`:

.. code-block:: python

    INSTALLED_APPS = (

        ...

        'groups_cache.apps.GroupsCacheConfig',

        ...

    )

Add the middleware to your `MIDDLEWARE_CLASSES`:

.. code-block:: python

    MIDDLEWARE_CLASSES = (

        'django.contrib.sessions.middleware.SessionMiddleware',

        'django.contrib.auth.middleware.AuthenticationMiddleware',

        ...

        'groups_cache.middleware.GroupsCacheMiddleware',

    )

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

.. code-block:: python

    {% if "admins" in request.groups_cache %}

      Admin Panel

    {% endif %}

    # or use templatetag, note that templatetag is slower

    {% load has_group %}

    {% if request.user|has_group:"admins" %}

      Admin Panel

    {% endif %}

Turn on caching:

.. code-block:: python

    CACHES = {

        'default': {

            'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',

            'LOCATION': '127.0.0.1:11211',

        }

    }

See https://docs.djangoproject.com/en/1.10/topics/cache/#memcached for more details on setting

up memcached.

Note**

Using `django.core.cache.backends.locmem.LocMemCache` is not safe for production unless you are

only running a single process (and odds are you aren't).

See https://docs.djangoproject.com/en/1.10/topics/cache/#local-memory-caching for more details.

Features

--------

* Adds `groups_cache` property to `request` object

* Provides templatetag `has_group`

* Invalidates cache on `User` or `Group` model changes and on m2m `groups` ManyToManyField changes

* Fully tested with high coverage

Running Tests

-------------

::

    source /bin/activate

    (myenv) $ pip install tox

    (myenv) $ tox

Credits

-------

Tools used in rendering this package:

*  Cookiecutter_

*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage