Metadata-Version: 2.1
Name: eit_django_utils
Version: 0.3.1
Summary: django utils for eit 
Author-email: Daniel Nall <sdnall@ncsu.edu>
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: Django >=2.2
Requires-Dist: django-hijack <= 2.3.0
Project-URL: Home, https://github.ncsu.edu/EIT/eit_django_utils

=============================
EIT Django Utils
=============================

Convenient utils for EIT Django dev

Documentation
-------------

Quickstart
----------

Install EIT Django Utils::

    pip install git+ssh://git@github.ncsu.edu/EIT/eit_django_utils.git

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'django-cors-headers',
        'django-hijack',
        'eit_django_utils',
        ...
    )

Add EIT Django Utils's URL patterns:

.. code-block:: python

    from eit_django_utils import urls as eit_django_utils_urls


    urlpatterns = [
        ...
        url(r'^eit_utils/', include(eit_django_utils_urls, namespace='eit_django_utils')),
        ...
    ]

Using with Django 2.2+ settings.py:

  .. code-block:: python

    MIDDLEWARE = [
      ...
      'django.contrib.auth.middleware.AuthenticationMiddleware',
      # SetLocalDevShibUID is only for local development!
      'eit_django_utils.backends.custom_auth.SetLocalDevShibUID',
      'eit_django_utils.backends.custom_auth.CustomHijackMiddleware',
      'eit_django_utils.backends.custom_auth.CustomHeaderMiddleware',
      'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
      ...
    ]

    AUTHENTICATION_BACKENDS = (
    'eit_django_utils.backends.custom_auth.CustomRemoteUserBackend',
    )

    LOCALDEV_SHIB_UID = 'desired_unity_id'



