forked from Peter-Slump/django-keycloak
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.rst
96 lines (66 loc) · 2.63 KB
/
README.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
CLONE OF https://github.com/Peter-Slump/django-keycloak
=======================================================
===============
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.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