Skip to main content

Install Django Keycloak.

Project description

Build Status Documentation Status codecov Maintainability

Django app to add Keycloak support to your project.

Read documentation

An showcase/demo project is added in the example folder.


Install development environment:

$ make install-python

Writing docs

Documentation is written using Sphinx and maintained in the docs folder.

To make it easy to write docs Docker support is available.

First build the Docker container:

$ docker build . -f DockerfileDocs -t django-keycloak-docs

Run the container

$ docker run -v `pwd`:/src --rm -t -i -p 8050:8050 django-keycloak-docs

Go in the browser to http://localhost:8050 and view the documentation which get refreshed and updated on every update in the documentation source.

Create release

$ git checkout master
$ git pull
$ bumpversion release
$ make deploy-pypi
$ bumpversion --no-tag patch
$ git push origin master --tags

Release Notes



  • Added support for remote user. Handling identities without registering a User model. (thanks to bossan)

  • Addes support for permissions using resources and scopes. (thanks to bossan)

  • Updated documentation.


  • Correctly extract email field name on UserModel (thanks to swist)

  • Add support for Oauth2 Token Exchange to exchange tokens with remote clients. Handy when using multiple applications with different clients which have to communicate with each other.

  • Support for session iframe

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

django-keycloak-0.1.1.tar.gz (24.2 kB view hashes)

Uploaded source

Built Distributions

django_keycloak-0.1.1-py3-none-any.whl (41.9 kB view hashes)

Uploaded py3

django_keycloak-0.1.1-py2-none-any.whl (43.0 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page