https://github.com/weibeu/flask-discord
Discord OAuth2 extension for Flask. An Easier implementation of "Log In With Discord".
https://github.com/weibeu/flask-discord
dashboard discord discord-oauth2-extension flask flask-discord flask-extension oauth2 python
Last synced: 3 months ago
JSON representation
Discord OAuth2 extension for Flask. An Easier implementation of "Log In With Discord".
- Host: GitHub
- URL: https://github.com/weibeu/flask-discord
- Owner: weibeu
- License: mit
- Created: 2019-05-06T10:48:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T00:16:00.000Z (10 months ago)
- Last Synced: 2025-03-31T12:07:28.247Z (3 months ago)
- Topics: dashboard, discord, discord-oauth2-extension, flask, flask-discord, flask-extension, oauth2, python
- Language: Python
- Homepage: https://flask-discord.readthedocs.io/en/latest/
- Size: 2.16 MB
- Stars: 182
- Watchers: 5
- Forks: 48
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.rst
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Flask-Discord
[](https://pypi.org/project/Flask-Discord/) [](https://flask-discord.readthedocs.io/en/latest/) [](https://discord.gg/7CrQEyP)
Discord OAuth2 extension for Flask.
### Installation
To install current latest release you can use following command:
```sh
python3 -m pip install Flask-Discord
```
### Basic Example
```python
import os
from flask import Flask, redirect, url_for
from flask_discord import DiscordOAuth2Session, requires_authorization, Unauthorized
app = Flask(__name__)
app.secret_key = b"random bytes representing flask secret key"
os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "true" # !! Only in development environment.
app.config["DISCORD_CLIENT_ID"] = 490732332240863233 # Discord client ID.
app.config["DISCORD_CLIENT_SECRET"] = "" # Discord client secret.
app.config["DISCORD_REDIRECT_URI"] = "" # URL to your callback endpoint.
app.config["DISCORD_BOT_TOKEN"] = "" # Required to access BOT resources.
discord = DiscordOAuth2Session(app)
@app.route("/login/")
def login():
return discord.create_session()
@app.route("/callback/")
def callback():
discord.callback()
return redirect(url_for(".me"))
@app.errorhandler(Unauthorized)
def redirect_unauthorized(e):
return redirect(url_for("login"))
@app.route("/me/")
@requires_authorization
def me():
user = discord.fetch_user()
return f"""
{user.name}
"""
if __name__ == "__main__":
app.run()
```
For an example to the working application, check [`test_app.py`](tests/test_app.py)
### Requirements
* Flask
* requests_oauthlib
* cachetools
* discord.py
### Documentation
Head over to [documentation] for full API reference.
[documentation]: https://flask-discord.readthedocs.io/en/latest/