yawaflua/Flask-Discord
1
0
Fork 0
mirror of https://github.com/yawaflua/Flask-Discord.git synced 2025-12-10 04:19:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs fixes

Browse Source
This commit is contained in:
thecosmos
2019-05-09 16:25:54 +05:30
parent 53fed2b543
commit bf49390a4c
5 changed files with 52 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/api.rst
View File

@@ -7,11 +7,11 @@ attributes and available methods.
Discord OAuth2 Client Discord OAuth2 Client
--------------------- ---------------------
.. autoclass:: flask_discord.DiscordOAuth2Session() .. autoclass:: flask_discord.DiscordOAuth2Session
:members: :members:
:inherited-members: :inherited-members:
.. autoclass:: flask_discord._http.DiscordOAuth2HttpClient() .. autoclass:: flask_discord._http.DiscordOAuth2HttpClient
:members: :members:
:inherited-members: :inherited-members:
@@ -19,22 +19,22 @@ Discord OAuth2 Client
Models Models
------ ------
.. autoclass:: flask_discord.models.Guild() .. autoclass:: flask_discord.models.Guild
:members: :members:
:inherited-members: :inherited-members:
.. autoclass:: flask_discord.models.User() .. autoclass:: flask_discord.models.User
:members: :members:
:inherited-members: :inherited-members:
.. autoclass:: flask_discord.models.Bot() .. autoclass:: flask_discord.models.Bot
:members: :members:
:inherited-members: :inherited-members:
.. autoclass:: flask_discord.models.Integration() .. autoclass:: flask_discord.models.Integration
:members: :members:
:inherited-members: :inherited-members:
.. autoclass:: flask_discord.models.UserConnection() .. autoclass:: flask_discord.models.UserConnection
:members: :members:
:inherited-members: :inherited-members:

3
docs/conf.py
View File

@@ -39,6 +39,9 @@ release = ver
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',
'sphinx.ext.intersphinx',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'pallets_sphinx_themes', 'pallets_sphinx_themes',
] ]

76
docs/introduction.rst
View File

@@ -14,11 +14,11 @@ permissions.
Requirements Requirements
------------ ------------
This extensions requires ``Flask`` installed. Python version can be chosen - **Flask**
as per ``Flask`` requirements. This is an Flask extension.
It also requires another library ``requests_oauthlib`` to create OAuth2 sessions - **requests_oauthlib**
to discord. It also requires requests_oauthlib to make OAuth2 sessions with discord.
Installing Installing
---------- ----------
@@ -26,12 +26,12 @@ Installing
You can install Flask-Discord directly from PyPI using PIP and following command You can install Flask-Discord directly from PyPI using PIP and following command
in shell or command prompt: :: in shell or command prompt: ::
python3 -m pip install -U Flask-Discord python3 -m pip install -U Flask-Discord
You can also install the latest development version (**maybe unstable/broken**) by You can also install the latest development version (**maybe unstable/broken**) by
using following command: :: using following command: ::
python3 -m pip install -U git+https://github.com/thec0sm0s/Flask-Discord.git python3 -m pip install -U git+https://github.com/thec0sm0s/Flask-Discord.git@dev
Basic Usage Basic Usage
@@ -42,44 +42,44 @@ in exchange for fetching user's details and display them on web page.
.. code-block:: python3 .. code-block:: python3
from flask import Flask, redirect, url_for from flask import Flask, redirect, url_for
from flask_discord import DiscordOAuth2Session from flask_discord import DiscordOAuth2Session
CONFIGS = { CONFIGS = {
"client_id": 9999999999, "client_id": 9999999999,
"client_secret": "your client secret", "client_secret": "your client secret",
"redirect_uri": "default redirect uri", "redirect_uri": "default redirect uri",
} }
app = Flask(__name__) app = Flask(__name__)
app.secret_key = "random bytes representing flask secret key" app.secret_key = "random bytes representing flask secret key"
discord = DiscordOAuth2Session(**CONFIGS) discord = DiscordOAuth2Session(**CONFIGS)
@app.route("/login") @app.route("/login")
def login(): def login():
return discord.create_session() return discord.create_session()
@app.route("/callback") @app.route("/callback")
def callback(): def callback():
discord.callback() discord.callback()
return redirect(url_for(".me")) return redirect(url_for(".me"))
@app.route("/me") @app.route("/me")
def me(): def me():
user = discord.fetch_user() user = discord.fetch_user()
return f""" return f"""
<html> <html>
<head> <head>
<title>{user.name}</title> <title>{user.name}</title>
</head> </head>
<body> <body>
<img src='{user.avatar_url}' /> <img src='{user.avatar_url}' />
</body> </body>
</html> </html>"""
"""
if __name__ == "__main__":
app.run() if __name__ == "__main__":
app.run()

6
flask_discord/_http.py
View File

@@ -9,7 +9,8 @@ from requests_oauthlib import OAuth2Session
class DiscordOAuth2HttpClient(abc.ABC): class DiscordOAuth2HttpClient(abc.ABC):
"""An OAuth2 http abstract base class providing some factory methods. """An OAuth2 http abstract base class providing some factory methods.
This class is meant to be overridden by flask_discord.DiscordOAuth2Session class. This class is meant to be overridden by :py:class:`flask_discord.DiscordOAuth2Session`
and should not be used directly.
Attributes Attributes
---------- ----------
@@ -75,8 +76,7 @@ class DiscordOAuth2HttpClient(abc.ABC):
Parameters Parameters
---------- ----------
route : str route : str
Route or endpoint URL to send HTTP GET request to. Route or endpoint URL to send HTTP GET request to. Example: ``/users/@me``
Example: ``/users/@me``
Returns Returns
------- -------

2
flask_discord/client.py
View File

@@ -7,7 +7,7 @@ class DiscordOAuth2Session(_http.DiscordOAuth2HttpClient):
"""Main client class representing hypothetical OAuth2 session with discord. """Main client class representing hypothetical OAuth2 session with discord.
It uses Flask `session <http://flask.pocoo.org/docs/1.0/api/#flask.session>`_ local proxy object It uses Flask `session <http://flask.pocoo.org/docs/1.0/api/#flask.session>`_ local proxy object
to save state, authorization token and keeps record of users sessions across different requests. to save state, authorization token and keeps record of users sessions across different requests.
This class inherits flask_discord._http.DiscordOAuth2HttpClient class which This class inherits :py:class:`flask_discord._http.DiscordOAuth2HttpClient` class.
Parameters Parameters
---------- ----------