Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sn1f3rt/quartcord
Discord OAuth2 extension for Quart.
https://github.com/sn1f3rt/quartcord
discord discord-py oauth2 quart quart-extension
Last synced: 2 days ago
JSON representation
Discord OAuth2 extension for Quart.
- Host: GitHub
- URL: https://github.com/sn1f3rt/quartcord
- Owner: sn1f3rt
- License: mit
- Created: 2023-12-29T15:57:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-30T10:29:19.000Z (about 1 year ago)
- Last Synced: 2025-01-27T17:07:51.272Z (7 days ago)
- Topics: discord, discord-py, oauth2, quart, quart-extension
- Language: Python
- Homepage: https://quartcord.rtfd.io
- Size: 2.01 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# quartcord
[](https://pypi.org/project/quartcord/) [](https://github.com/Sn1F3rt/quartcord/actions/workflows/build.yml) [](https://quartcord.readthedocs.io/en/latest/?badge=latest)
## Table of Contents
- [About](#about)
- [Installation](#installation)
* [Requirements](#requirements)
* [Setup](#setup)
- [Basic Example](#basic-example)
- [Documentation](#documentation)
- [Support](#support)
- [Credits](#credits)
- [License](#license)
## About
Discord OAuth2 extension for Quart.
## Installation
### Requirements
- Quart
- pyjwt
- aiohttp
- oauthlib
- discord.py
- cachetools
- Async-OAuthlib
### Setup
To install current latest release you can use following command:
```sh
python -m pip install quartcord
```
## Basic Example
```python
from quart import Quart, redirect, url_for
from quartcord import DiscordOAuth2Session, requires_authorization, Unauthorized
app = Quart(__name__)
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.
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/")
async def login():
return await discord.create_session()
@app.route("/callback/")
async def callback():
await discord.callback()
return redirect(url_for(".me"))
@app.errorhandler(Unauthorized)
async def redirect_unauthorized(e):
return redirect(url_for("login"))
@app.route("/me/")
@requires_authorization
async def me():
user = await discord.fetch_user()
return f"""
{user.name}
"""
if __name__ == "__main__":
app.run()
```
## Documentation
Head over to [documentation](https://quartcord.readthedocs.io/en/latest/) for full API reference.
## Support
- [Project Issues](https://github.com/Sn1F3rt/quartcord/issues)
- [FumeStop Community Server](https://fumes.top/community) **(``Help > quartcord``)**
## Credits
- [Flask-Discord](https://github.com/weibeu/Flask-Discord/)
- [Quart-Discord](https://github.com/jnawk/Quart-Discord/) **(Do not use; no longer maintained)**
## License
[MIT License](LICENSE)
Copyright © 2023 Sayan "Sn1F3rt" Bhattacharyya