File: README.rst

package info (click to toggle)
flask-oauthlib 0.9.5-2
  • links: PTS, VCS
  • area: main
  • in suites: buster, sid
  • size: 664 kB
  • sloc: python: 4,870; makefile: 155
file content (97 lines) | stat: -rw-r--r-- 3,082 bytes parent folder | download
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
Flask-OAuthlib
==============

.. image:: https://img.shields.io/badge/donate-lepture-green.svg
   :target: https://typlog.com/donate?amount=10&reason=lepture%2Fflask-oauthlib
   :alt: Donate lepture
.. image:: https://img.shields.io/pypi/wheel/flask-oauthlib.svg
   :target: https://pypi.python.org/pypi/flask-OAuthlib/
   :alt: Wheel Status
.. image:: https://img.shields.io/pypi/v/flask-oauthlib.svg
   :target: https://pypi.python.org/pypi/flask-oauthlib/
   :alt: Latest Version
.. image:: https://travis-ci.org/lepture/flask-oauthlib.svg?branch=master
   :target: https://travis-ci.org/lepture/flask-oauthlib
   :alt: Travis CI Status
.. image:: https://coveralls.io/repos/lepture/flask-oauthlib/badge.svg?branch=master
   :target: https://coveralls.io/r/lepture/flask-oauthlib
   :alt: Coverage Status

Notice
------

**Please use https://github.com/lepture/authlib instead**.

=====

Flask-OAuthlib is an extension to Flask that allows you to interact with
remote OAuth enabled applications. On the client site, it is a replacement
for Flask-OAuth. But it does more than that, it also helps you to create
OAuth providers.

Flask-OAuthlib relies on oauthlib_.

.. _oauthlib: https://github.com/idan/oauthlib

Sponsored by
------------

If you want to quickly add secure authentication to Flask, feel free to
check out Auth0's Python API SDK and free plan at `auth0.com/overview`_
|auth0 image|

.. _`auth0.com/overview`: https://auth0.com/overview?utm_source=GHsponsor&utm_medium=GHsponsor&utm_campaign=flask-oauthlib&utm_content=auth

.. |auth0 image| image:: https://user-images.githubusercontent.com/290496/31718461-031a6710-b44b-11e7-80f8-7c5920c73b8f.png
   :target: https://auth0.com/overview?utm_source=GHsponsor&utm_medium=GHsponsor&utm_campaign=flask-oauthlib&utm_content=auth
   :alt: Coverage Status
   :width: 18px
   :height: 18px

Features
--------

- Support for OAuth 1.0a, 1.0, 1.1, OAuth2 client
- Friendly API (same as Flask-OAuth)
- Direct integration with Flask
- Basic support for remote method invocation of RESTful APIs
- Support OAuth1 provider with HMAC and RSA signature
- Support OAuth2 provider with Bearer token

And request more features at `github issues`_.

.. _`github issues`: https://github.com/lepture/flask-oauthlib/issues


Security Reporting
------------------

If you found security bugs which can not be public, send me email at `me@lepture.com`.
Attachment with patch is welcome.


Installation
------------

Installing flask-oauthlib is simple with pip_::

    $ pip install Flask-OAuthlib

If you don't have pip installed, try with easy_install::

    $ easy_install Flask-OAuthlib

.. _pip: http://www.pip-installer.org/


Additional Notes
----------------

We keep documentation at `flask-oauthlib@readthedocs`_.

.. _`flask-oauthlib@readthedocs`: https://flask-oauthlib.readthedocs.io

If you are only interested in the client part, you can find some examples
in the ``example`` directory.

There is also a `development version <https://github.com/lepture/flask-oauthlib/archive/master.zip#egg=Flask-OAuthlib-dev>`_ on GitHub.