Skip to main content

Integrate Keycloak with Django 5.2+

Project description

=============== Django Keycloak

.. image:: https://www.travis-ci.org/Peter-Slump/django-keycloak.svg?branch=master :target: https://www.travis-ci.org/Peter-Slump/django-keycloak :alt: Build Status .. image:: https://readthedocs.org/projects/django-keycloak/badge/?version=latest :target: http://django-keycloak.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status .. image:: https://codecov.io/gh/Peter-Slump/django-keycloak/branch/master/graph/badge.svg :target: https://codecov.io/gh/Peter-Slump/django-keycloak :alt: codecov .. image:: https://api.codeclimate.com/v1/badges/eb19f47dc03dec40cea7/maintainability :target: https://codeclimate.com/github/Peter-Slump/django-keycloak/maintainability :alt: Maintainability

Django app to add Keycloak support to your project.

Read documentation <http://django-keycloak.readthedocs.io/en/latest/>_

http://www.keycloak.org/

An showcase/demo project is added in the example folder <example/README.md>_.

Development

Install development environment:

.. code:: bash

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

.. code:: bash

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

Run the container

.. code:: bash

$ 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

.. code:: bash

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

Release Notes

unreleased

v0.2.5

  • Add registeration redirect view

v0.2.4

  • Fixed refresh token expiration date exists

v0.2.3

v0.2.2

  • Fixed issue by adding migration file to repo

v0.2.1

  • Added a feature to use redirect url after successful login using settings.LOGIN_REDIRECT_URL

v0.2.0

v0.1.2-dev

v0.1.1

  • Added support for remote user. Handling identities without registering a User model. (thanks to bossan <https://github.com/bossan>_)
  • Addes support for permissions using resources and scopes. (thanks to bossan <https://github.com/bossan>_)
  • Added example project.
  • Updated documentation.

v0.1.0

  • Correctly extract email field name on UserModel (thanks to swist <https://github.com/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

berlin_united_django_keycloak-0.2.6.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

berlin_united_django_keycloak-0.2.6-py3-none-any.whl (43.8 kB view details)

Uploaded Python 3

File details

Details for the file berlin_united_django_keycloak-0.2.6.tar.gz.

File metadata

File hashes

Hashes for berlin_united_django_keycloak-0.2.6.tar.gz
Algorithm Hash digest
SHA256 0c1fbe23225fa7fe1167135ff59cab6e45c7bd860a1a46e4c3657741be9f9f5b
MD5 639cfda84f083352121d115a5c146a28
BLAKE2b-256 b061572c597449431e006e505160f91c108e2f1ec5c7b9f5ddeef3145b1135e0

See more details on using hashes here.

File details

Details for the file berlin_united_django_keycloak-0.2.6-py3-none-any.whl.

File metadata

File hashes

Hashes for berlin_united_django_keycloak-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a27a1e1b2baf25a904c35e9ce98a8a6b12110ad994908e5914f9f769da3443f1
MD5 13087c2e7c9b7ef2b77b85c34a8802ef
BLAKE2b-256 719f32c2d8b772953ae750ac5d61c7668ea2ccd19901d453704c00aa0680a1b8

See more details on using hashes here.

Supported by

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