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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
Django OAuth Toolkit
====================
.. image:: https://jazzband.co/static/img/badge.svg
:target: https://jazzband.co/
:alt: Jazzband
*OAuth2 goodies for the Djangonauts!*
.. image:: https://badge.fury.io/py/django-oauth-toolkit.svg
:target: http://badge.fury.io/py/django-oauth-toolkit
.. image:: https://github.com/jazzband/django-oauth-toolkit/workflows/Test/badge.svg
:target: https://github.com/jazzband/django-oauth-toolkit/actions
:alt: GitHub Actions
.. image:: https://codecov.io/gh/jazzband/django-oauth-toolkit/branch/master/graph/badge.svg
:target: https://codecov.io/gh/jazzband/django-oauth-toolkit
:alt: Coverage
.. image:: https://img.shields.io/pypi/pyversions/django-oauth-toolkit.svg
:target: https://pypi.org/project/django-oauth-toolkit/
:alt: Supported Python versions
.. image:: https://img.shields.io/pypi/djversions/django-oauth-toolkit.svg
:target: https://pypi.org/project/django-oauth-toolkit/
:alt: Supported Django versions
If you are facing one or more of the following:
* Your Django app exposes a web API you want to protect with OAuth2 authentication,
* You need to implement an OAuth2 authorization server to provide tokens management for your infrastructure,
Django OAuth Toolkit can help you providing out of the box all the endpoints, data and logic needed to add OAuth2
capabilities to your Django projects. Django OAuth Toolkit makes extensive use of the excellent
`OAuthLib <https://github.com/idan/oauthlib>`_, so that everything is
`rfc-compliant <https://rfc-editor.org/rfc/rfc6749.html>`_.
Reporting security issues
-------------------------
Please report any security issues to the JazzBand security team at <security@jazzband.co>. Do not file an issue on the tracker.
Requirements
------------
* Python 3.8+
* Django 4.2, 5.0 or 5.1
* oauthlib 3.2.2+
Installation
------------
Install with pip::
pip install django-oauth-toolkit
Add ``oauth2_provider`` to your ``INSTALLED_APPS``
.. code-block:: python
INSTALLED_APPS = (
...
'oauth2_provider',
)
If you need an OAuth2 provider you'll want to add the following to your ``urls.py``.
.. code-block:: python
from oauth2_provider import urls as oauth2_urls
urlpatterns = [
...
path('o/', include(oauth2_urls)),
]
Changelog
---------
See `CHANGELOG.md <https://github.com/jazzband/django-oauth-toolkit/blob/master/CHANGELOG.md>`_.
Documentation
--------------
The `full documentation <https://django-oauth-toolkit.readthedocs.io/>`_ is on *Read the Docs*.
License
-------
django-oauth-toolkit is released under the terms of the **BSD license**. Full details in ``LICENSE`` file.
Help Wanted
-----------
We need help maintaining and enhancing django-oauth-toolkit (DOT).
Join the team
~~~~~~~~~~~~~
Please consider joining `Jazzband <https://jazzband.co>`__ (If not
already a member) and the `DOT project
team <https://jazzband.co/projects/django-oauth-toolkit>`__.
How you can help
~~~~~~~~~~~~~~~~
See our
`contributing <https://django-oauth-toolkit.readthedocs.io/en/latest/contributing.html>`__
info and the open
`issues <https://github.com/jazzband/django-oauth-toolkit/issues>`__ and
`PRs <https://github.com/jazzband/django-oauth-toolkit/pulls>`__,
especially those labeled
`help-wanted <https://github.com/jazzband/django-oauth-toolkit/labels/help-wanted>`__.
Discussions
~~~~~~~~~~~
Have questions or want to discuss the project?
See `the discussions <https://github.com/jazzband/django-oauth-toolkit/discussions>`__.
Submit PRs and Perform Reviews
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
PR submissions and reviews are always appreciated! Since we require an
independent review of any PR before it can be merged, having your second
set of eyes looking at PRs is extremely valuable.
Please don’t merge PRs
~~~~~~~~~~~~~~~~~~~~~~
Please be aware that we don’t want *every* Jazzband member to merge PRs
but just a handful of project team members so that we can maintain a
modicum of control over what goes into a release of this security oriented code base. Only `project
leads <https://jazzband.co/projects/django-oauth-toolkit>`__ are able to
publish releases to Pypi and it becomes difficult when creating a new
release for the leads to deal with “unexpected” merged PRs.
Become a Project Lead
~~~~~~~~~~~~~~~~~~~~~
If you are interested in stepping up to be a Project Lead, please take a look at
the `discussion about this <https://github.com/jazzband/django-oauth-toolkit/discussions/1479>`__.
|
