✔ Docs improvements

weibeu · Sep 11, 2020 · 5bd875c · 5bd875c
1 parent f435751
commit 5bd875c
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ from flask_discord import DiscordOAuth2Session, requires_authorization, Unauthor
 app = Flask(__name__)
 
 app.secret_key = b"random bytes representing flask secret key"
-os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "true"    # !! Only in development environment.
+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.

diff --git a/docs/introduction.rst b/docs/introduction.rst
@@ -54,8 +54,8 @@ in exchange for fetching user's details and display them on web page.
     app = Flask(__name__)
 
     app.secret_key = b"random bytes representing flask secret key"
-    os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "true"    # !! Only in development environment.
     # OAuth2 must make use of HTTPS in production environment.
+    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.
@@ -99,3 +99,26 @@ in exchange for fetching user's details and display them on web page.
 
     if __name__ == "__main__":
         app.run()
+
+**Lazy initialization with flask factory pattern**
+
+.. code-block:: python3
+
+    from flask_discord import DiscordOAuth2Session
+
+    discord = DiscordOAuth2Session()
+
+    def get_app():
+        app = Flask(__name__)
+
+        app.secret_key = b"random bytes representing flask secret key"
+        # OAuth2 must make use of HTTPS in production environment.
+        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.init_app(app)
+
+        return app