Documentation

2025-12-09 20:09:30 +02:00 · 2019-05-08 15:46:24 +05:30
parent b34f201155
commit ce488393e6
7 changed files with 282 additions and 10 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,68 @@
 # Flask-Discord
+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
+from flask import Flask, redirect, url_for
+from flask_discord import DiscordOAuth2Session
+
+CONFIGS = {
+	"client_id": 9999999999,
+	"client_secret": "your client secret",
+	"redirect_uri": "default redirect uri",
+}
+
+app = Flask(__name__)
+app.secret_key = "random bytes representing flask secret key"
+discord = DiscordOAuth2Session(**CONFIGS)
+
+
+@app.route("/login")
+def login():
+	return discord.create_session()
+	
+
+@app.route("/callback")
+def callback():
+	discord.callback()
+	return redirect(url_for(".me"))
+	
+	
+@app.route("/me")
+def me():
+	user = discord.fetch_user()
+	return f"""
+		<html>
+		<head>
+			<title>{user.name}</title>
+		</head>
+		<body>
+			<img src='{user.avatar_url}' />
+		</body>
+		</html>
+	
+	"""
+
+
+
+if __name__ == "__main__":
+	app.run()
+
+```
+
+
+### Requirements
+* Flask
+* requests_oauthlib
+
+
+### Documentation
+