| 1 |
Quickstart |
| 2 |
========== |
| 3 |
|
| 4 |
The fastest way to get up and running with Flask-Dance is to start from |
| 5 |
an example project. First, decide which :doc:`token storage |
| 6 |
<storages>` you want to use: |
| 7 |
|
| 8 |
* :class:`~flask_dance.consumer.storage.session.SessionStorage` is the default |
| 9 |
because it requires zero configuration. It uses the |
| 10 |
:ref:`Flask session <flask:sessions>` to store OAuth tokens. |
| 11 |
It's the easiest for getting started, but it's not a good choice for |
| 12 |
production applications. |
| 13 |
* :class:`~flask_dance.consumer.storage.sqla.SQLAlchemyStorage` uses a |
| 14 |
relational database to store OAuth tokens. It's great for production usage, |
| 15 |
but it requires a relational database with `SQLAlchemy`_ |
| 16 |
and it's more complicated to set up. |
| 17 |
|
| 18 |
If you're not sure which to pick, start with ``SessionStorage``. |
| 19 |
You can switch later, if you want. |
| 20 |
|
| 21 |
Next, check the lists below to find the OAuth provider you're interested in |
| 22 |
and jump to an example project that uses Flask-Dance with that provider! |
| 23 |
|
| 24 |
Flask sessions (easiest) |
| 25 |
------------------------ |
| 26 |
|
| 27 |
* `GitHub <https://github.com/singingwolfboy/flask-dance-github>`__ |
| 28 |
* `Google <https://github.com/singingwolfboy/flask-dance-google>`__ |
| 29 |
* `Facebook <https://github.com/singingwolfboy/flask-dance-facebook>`__ |
| 30 |
* `Slack <https://github.com/singingwolfboy/flask-dance-slack>`__ |
| 31 |
* `LinkedIn <https://github.com/singingwolfboy/flask-dance-linkedin>`__ |
| 32 |
* `Heroku <https://github.com/singingwolfboy/flask-dance-heroku>`__ |
| 33 |
* `Fitbit <https://github.com/lila/flask-dance-fitbit>`__ |
| 34 |
|
| 35 |
SQLAlchemy |
| 36 |
---------- |
| 37 |
|
| 38 |
* `Google <https://github.com/singingwolfboy/flask-dance-google-sqla>`__ |
| 39 |
* `Google with Flask-Security <https://github.com/singingwolfboy/flask-dance-google-security-sqla>`__ |
| 40 |
* `Facebook <https://github.com/singingwolfboy/flask-dance-facebook-sqla>`__ |
| 41 |
* `Heroku <https://github.com/singingwolfboy/flask-dance-heroku-sqla>`__ |
| 42 |
* `Multiple providers simultaneously <https://github.com/singingwolfboy/flask-dance-multi-provider>`__ |
| 43 |
|
| 44 |
.. admonition:: Other Providers |
| 45 |
|
| 46 |
Don't see the OAuth provider you want? Flask-Dance provides |
| 47 |
:doc:`built-in support for even more providers <providers>`, |
| 48 |
and you can configure Flask-Dance to support |
| 49 |
:ref:`any custom provider you want <custom-provider>`. |
| 50 |
Start with any of the example projects listed above, and modify it to use |
| 51 |
the provider you want! |
| 52 |
|
| 53 |
.. _SQLAlchemy: http://www.sqlalchemy.org/ |