django-oauth-toolkit


Namedjango-oauth-toolkit JSON
Version 3.0.1 PyPI version JSON
download
home_pageNone
SummaryOAuth2 Provider for Django
upload_time2024-09-07 14:07:57
maintainerNone
docs_urlNone
authorFederico Frenguelli, Massimiliano Pippi
requires_python>=3.8
licenseCopyright (c) 2013, Massimiliano Pippi, Federico Frenguelli and contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of the FreeBSD Project.
keywords django oauth oauth2 oauthlib
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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>`__.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "django-oauth-toolkit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "django, oauth, oauth2, oauthlib",
    "author": "Federico Frenguelli, Massimiliano Pippi",
    "author_email": "synasius@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/fa/d3/d7628a7a4899bf5aafc9c1ec121c507470b37a247f7628acae6e0f78e0d6/django_oauth_toolkit-3.0.1.tar.gz",
    "platform": null,
    "description": "Django OAuth Toolkit\n====================\n\n.. image:: https://jazzband.co/static/img/badge.svg\n   :target: https://jazzband.co/\n   :alt: Jazzband\n\n*OAuth2 goodies for the Djangonauts!*\n\n.. image:: https://badge.fury.io/py/django-oauth-toolkit.svg\n    :target: http://badge.fury.io/py/django-oauth-toolkit\n\n.. image:: https://github.com/jazzband/django-oauth-toolkit/workflows/Test/badge.svg\n   :target: https://github.com/jazzband/django-oauth-toolkit/actions\n   :alt: GitHub Actions\n\n.. image:: https://codecov.io/gh/jazzband/django-oauth-toolkit/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/jazzband/django-oauth-toolkit\n   :alt: Coverage\n\n.. image:: https://img.shields.io/pypi/pyversions/django-oauth-toolkit.svg\n   :target: https://pypi.org/project/django-oauth-toolkit/\n   :alt: Supported Python versions\n\n.. image:: https://img.shields.io/pypi/djversions/django-oauth-toolkit.svg\n   :target: https://pypi.org/project/django-oauth-toolkit/\n   :alt: Supported Django versions\n\nIf you are facing one or more of the following:\n * Your Django app exposes a web API you want to protect with OAuth2 authentication,\n * You need to implement an OAuth2 authorization server to provide tokens management for your infrastructure,\n\nDjango OAuth Toolkit can help you providing out of the box all the endpoints, data and logic needed to add OAuth2\ncapabilities to your Django projects. Django OAuth Toolkit makes extensive use of the excellent\n`OAuthLib <https://github.com/idan/oauthlib>`_, so that everything is\n`rfc-compliant <https://rfc-editor.org/rfc/rfc6749.html>`_.\n\nReporting security issues\n-------------------------\n\nPlease report any security issues to the JazzBand security team at <security@jazzband.co>. Do not file an issue on the tracker.\n\nRequirements\n------------\n\n* Python 3.8+\n* Django 4.2, 5.0 or 5.1\n* oauthlib 3.2.2+\n\nInstallation\n------------\n\nInstall with pip::\n\n    pip install django-oauth-toolkit\n\nAdd ``oauth2_provider`` to your ``INSTALLED_APPS``\n\n.. code-block:: python\n\n    INSTALLED_APPS = (\n        ...\n        'oauth2_provider',\n    )\n\n\nIf you need an OAuth2 provider you'll want to add the following to your ``urls.py``.\n\n.. code-block:: python\n\n    from oauth2_provider import urls as oauth2_urls\n\n    urlpatterns = [\n        ...\n        path('o/', include(oauth2_urls)),\n    ]\n\nChangelog\n---------\n\nSee `CHANGELOG.md <https://github.com/jazzband/django-oauth-toolkit/blob/master/CHANGELOG.md>`_.\n\n\nDocumentation\n--------------\n\nThe `full documentation <https://django-oauth-toolkit.readthedocs.io/>`_ is on *Read the Docs*.\n\nLicense\n-------\n\ndjango-oauth-toolkit is released under the terms of the **BSD license**. Full details in ``LICENSE`` file.\n\nHelp Wanted\n-----------\n\nWe need help maintaining and enhancing django-oauth-toolkit (DOT).\n\nJoin the team\n~~~~~~~~~~~~~\n\nPlease consider joining `Jazzband <https://jazzband.co>`__ (If not\nalready a member) and the `DOT project\nteam <https://jazzband.co/projects/django-oauth-toolkit>`__.\n\nHow you can help\n~~~~~~~~~~~~~~~~\n\nSee our\n`contributing <https://django-oauth-toolkit.readthedocs.io/en/latest/contributing.html>`__\ninfo and the open\n`issues <https://github.com/jazzband/django-oauth-toolkit/issues>`__ and\n`PRs <https://github.com/jazzband/django-oauth-toolkit/pulls>`__,\nespecially those labeled\n`help-wanted <https://github.com/jazzband/django-oauth-toolkit/labels/help-wanted>`__.\n\nDiscussions\n~~~~~~~~~~~\nHave questions or want to discuss the project?\nSee `the discussions <https://github.com/jazzband/django-oauth-toolkit/discussions>`__.\n\n\nSubmit PRs and Perform Reviews\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nPR submissions and reviews are always appreciated! Since we require an\nindependent review of any PR before it can be merged, having your second\nset of eyes looking at PRs is extremely valuable.\n\nPlease don\u2019t merge PRs\n~~~~~~~~~~~~~~~~~~~~~~\n\nPlease be aware that we don\u2019t want *every* Jazzband member to merge PRs\nbut just a handful of project team members so that we can maintain a\nmodicum of control over what goes into a release of this security oriented code base. Only `project\nleads <https://jazzband.co/projects/django-oauth-toolkit>`__ are able to\npublish releases to Pypi and it becomes difficult when creating a new\nrelease for the leads to deal with \u201cunexpected\u201d merged PRs.\n\nBecome a Project Lead\n~~~~~~~~~~~~~~~~~~~~~\n\nIf you are interested in stepping up to be a Project Lead, please take a look at\nthe `discussion about this <https://github.com/jazzband/django-oauth-toolkit/discussions/1479>`__.\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2013, Massimiliano Pippi, Federico Frenguelli and contributors All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of the FreeBSD Project. ",
    "summary": "OAuth2 Provider for Django",
    "version": "3.0.1",
    "project_urls": {
        "Homepage": "https://django-oauth-toolkit.readthedocs.io/",
        "Repository": "https://github.com/jazzband/django-oauth-toolkit"
    },
    "split_keywords": [
        "django",
        " oauth",
        " oauth2",
        " oauthlib"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7d40e556bc19ba65356fe5f0e48ca01c50e81f7c630042fa7411b6ab428ecf68",
                "md5": "c9fcdb854a483c454dd7fa91e3f8a6cb",
                "sha256": "3ef00b062a284f2031b0732b32dc899e3bbf0eac221bbb1cffcb50b8932e55ed"
            },
            "downloads": -1,
            "filename": "django_oauth_toolkit-3.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c9fcdb854a483c454dd7fa91e3f8a6cb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 77299,
            "upload_time": "2024-09-07T14:08:43",
            "upload_time_iso_8601": "2024-09-07T14:08:43.225218Z",
            "url": "https://files.pythonhosted.org/packages/7d/40/e556bc19ba65356fe5f0e48ca01c50e81f7c630042fa7411b6ab428ecf68/django_oauth_toolkit-3.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fad3d7628a7a4899bf5aafc9c1ec121c507470b37a247f7628acae6e0f78e0d6",
                "md5": "35b2a6bba76c57672a9063390a62dcc3",
                "sha256": "7200e4a9fb229b145a6d808cbf0423b6d69a87f68557437733eec3c0cf71db02"
            },
            "downloads": -1,
            "filename": "django_oauth_toolkit-3.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "35b2a6bba76c57672a9063390a62dcc3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 99816,
            "upload_time": "2024-09-07T14:07:57",
            "upload_time_iso_8601": "2024-09-07T14:07:57.124702Z",
            "url": "https://files.pythonhosted.org/packages/fa/d3/d7628a7a4899bf5aafc9c1ec121c507470b37a247f7628acae6e0f78e0d6/django_oauth_toolkit-3.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-07 14:07:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jazzband",
    "github_project": "django-oauth-toolkit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "django-oauth-toolkit"
}
        
Elapsed time: 0.54636s