django-dataporten 0.2.2

Quick start

1. Add “dataporten” to your INSTALLED_APPS setting like this

INSTALLED_APPS = [
    ...
    'dataporten',
]

2. Run python manage.py migrate to create the dataporten proxy models.

3. In your settings.py file, add the variable DATAPORTEN_TOKEN_FUNCTION, which should be a dotted path to the function that will retrieve user tokens. The function should accept a User and return a str. Here is a python3.6/3.7 example that will work if you use django-allauth:

def allauth_token(user: User) -> str:
    return SocialToken.objects.get(
        account__user=user,
        account__provider='dataporten',
    ).token

4. Add the dataporten middleware. This middleware adds a dataporten attribute to request.user for users with an associated dataporten SocialToken object. Take care to place it after django.contrib.auth.middleware.AuthenticationMiddleware.

MIDDLEWARE = (
    # Other middleware...
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    # Other middleware...

    # Adds dataporten API information to request.user.dataporten
    # Needs to be placed after any authentication middleware, as this
    # requires inspection of request.user
    'dataporten.middleware.DataportenGroupsMiddleware',
    # Other middleware...
)

5. Optionally, enable caching for API queries. Take care to create the directory set in DATAPORTEN_CACHE_PATH before starting the Django server.

# Cache requests to the dataporten API
DATAPORTEN_CACHE_REQUESTS = True

# Where to save the sqlite3 cache backend
DATAPORTEN_CACHE_PATH = 'tmp/'

export DJANGO_SETTINGS_MODULE=dataporten.settings
pytest