Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lepture committed Oct 10, 2019
1 parent 2547233 commit 57785c1
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 32 deletions.
2 changes: 1 addition & 1 deletion docs/client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Client

.. note::

Please read https://docs.authlib.org/en/latest/client/frameworks.html
You SHOULD read `Flask OAuth Client <https://docs.authlib.org/en/latest/client/flask.html>`_ documentation.

The client part keeps the same API as `Flask-OAuth`_. The only changes are
the imports::
Expand Down
36 changes: 7 additions & 29 deletions docs/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,20 @@ Introduction
============

Flask-OAuthlib is designed to be a replacement for Flask-OAuth. It depends on
oauthlib_.
oauthlib.

Why
---

The original `Flask-OAuth`_ suffers from lack of maintenance, and oauthlib_ is a
promising replacement for `python-oauth2`_.
No, you should not use this library any more. PLEASE SWITCH to Authlib_ instead.

.. _`Flask-OAuth`: http://pythonhosted.org/Flask-OAuth/
.. _oauthlib: https://github.com/idan/oauthlib
.. _`python-oauth2`: https://pypi.python.org/pypi/oauth2/
Find out documentation for:

There are lots of non-standard services that claim they are oauth providers, but
their APIs are always broken. While rewriting an oauth extension for Flask, I
took them into consideration. Flask-OAuthlib does support these non-standard
services.

Flask-OAuthlib also provides the solution for creating an oauth service. It
supports both oauth1 and oauth2 (with Bearer Token).

import this
-----------

Flask-OAuthlib was developed with a few :pep:`20` idioms in mind::

>>> import this


#. Beautiful is better than ugly.
#. Explicit is better than implicit.
#. Simple is better than complex.
#. Complex is better than complicated.
#. Readability counts.

All contributions to Flask-OAuthlib should keep these important rules in mind.
1. `Flask OAuth Client <https://docs.authlib.org/en/latest/client/flask.html>`_
2. `Flask OAuth 1.0 Provider <https://docs.authlib.org/en/latest/flask/1/>`_
3. `Flask OAuth 2.0 Provider <https://docs.authlib.org/en/latest/flask/2/>`_

.. _Authlib: https://authlib.org/

License
-------
Expand Down
2 changes: 1 addition & 1 deletion docs/oauth1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ OAuth1 Server

.. note::

Please read https://docs.authlib.org/en/latest/flask/oauth1.html
You SHOULD read `Flask OAuth 1.0 Provider <https://docs.authlib.org/en/latest/flask/1/>`_ documentation.

This part of documentation covers the tutorial of setting up an OAuth1
provider. An OAuth1 server concerns how to grant the authorization and
Expand Down
2 changes: 1 addition & 1 deletion docs/oauth2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ OAuth2 Server

.. note::

Please read https://docs.authlib.org/en/latest/flask/oauth2.html
You SHOULD read `Flask OAuth 2.0 Provider <https://docs.authlib.org/en/latest/flask/2/>`_ documentation.

An OAuth2 server concerns how to grant the authorization and how to protect
the resource. Register an **OAuth** provider::
Expand Down

0 comments on commit 57785c1

Please sign in to comment.