replaced all flask references with quart references

This commit is contained in:
Philip Dowie
2020-08-15 23:27:15 +12:00
parent d23441a070
commit 2076f1c1df
21 changed files with 120 additions and 120 deletions

View File

@@ -5,7 +5,7 @@
Introduction
============
Flask-Discord is an extension for Flask - Python web framework which
Quart-Discord is an extension for Quart - Python web framework which
makes easy implementation of Discord OAuth2 API. After creating a discord
client object, one can easily request authorization and hence any of the
resources provided by the discord OAuth2 API under the available scope
@@ -14,14 +14,14 @@ permissions.
Requirements
------------
- **Flask**
This is an Flask extension.
- **Quart**
This is a Quart extension.
- **requests_oauthlib**
It also requires requests_oauthlib to make OAuth2 sessions with discord.
- **cachetools**
Flask Discord supports caching discord objects to boost the performance when page loads.
Quart Discord supports caching discord objects to boost the performance when page loads.
- **discord.py**
Makes use of discord.py for re-using many Discord models.
@@ -29,15 +29,15 @@ Requirements
Installing
----------
You can install Flask-Discord directly from PyPI using PIP and following command
You can install Quart-Discord directly from PyPI using PIP and following command
in shell or command prompt: ::
python3 -m pip install -U Flask-Discord
python3 -m pip install -U Quart-Discord
You can also install the latest development version (**maybe unstable/broken**) by
using following command: ::
python3 -m pip install -U git+https://github.com/thec0sm0s/Flask-Discord.git@dev
python3 -m pip install -U git+https://github.com/jnawk/Quart-Discord.git@dev
Basic Usage
@@ -48,12 +48,12 @@ in exchange for fetching user's details and display them on web page.
.. code-block:: python3
from flask import Flask, redirect, url_for
from flask_discord import DiscordOAuth2Session, requires_authorization, Unauthorized
from quart import Quart, redirect, url_for
from quart_discord import DiscordOAuth2Session, requires_authorization, Unauthorized
app = Flask(__name__)
app = Quart(__name__)
app.secret_key = b"random bytes representing flask secret key"
app.secret_key = b"random bytes representing quart secret key"
app.config["DISCORD_CLIENT_ID"] = 490732332240863233 # Discord client ID.
app.config["DISCORD_CLIENT_SECRET"] = "" # Discord client secret.