Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tert0/fastapi-discord
Discord OAuth FastAPI extension for APIs
https://github.com/tert0/fastapi-discord
aiohttp asyncio fastapi hacktoberfest python
Last synced: 2 days ago
JSON representation
Discord OAuth FastAPI extension for APIs
- Host: GitHub
- URL: https://github.com/tert0/fastapi-discord
- Owner: Tert0
- License: mit
- Created: 2021-03-23T11:06:28.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-19T21:00:18.000Z (18 days ago)
- Last Synced: 2024-12-29T02:17:50.980Z (9 days ago)
- Topics: aiohttp, asyncio, fastapi, hacktoberfest, python
- Language: Python
- Homepage:
- Size: 216 KB
- Stars: 70
- Watchers: 3
- Forks: 18
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/py/fastapi-discord)
[](https://pypi.org/project/fastapi-discord)
# FastAPI Discord (OAuth)
Support for "Login with Discord"/ Discord OAuth for FastAPI.
# Install
PIP Package `fastapi-discord`
# Example
You can find the Example in [examples/](https://github.com/Tert0/fastapi-discord/tree/master/examples)
```py
from typing import List
from contextlib import asynccontextmanager
from fastapi import Depends, FastAPI
from fastapi.responses import JSONResponse
from fastapi_discord import DiscordOAuthClient, RateLimited, Unauthorized, User
from fastapi_discord.exceptions import ClientSessionNotInitialized
from fastapi_discord.models import GuildPreview
discord = DiscordOAuthClient(
"", "", "", ("identify", "guilds", "email")
) # scopes
# startup is now deprecated https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated
# use lifespan https://fastapi.tiangolo.com/advanced/events/
@asynccontextmanager
async def lifespan(_app: FastAPI):
await discord.init()
yield
app = FastAPI()
# @app.on_event("startup")
# async def on_startup():
# await discord.init()
@app.get("/login")
async def login():
return {"url": discord.oauth_login_url}
@app.get("/callback")
async def callback(code: str):
token, refresh_token = await discord.get_access_token(code)
return {"access_token": token, "refresh_token": refresh_token}
@app.get(
"/authenticated",
dependencies=[Depends(discord.requires_authorization)],
response_model=bool,
)
async def isAuthenticated(token: str = Depends(discord.get_token)):
try:
auth = await discord.isAuthenticated(token)
return auth
except Unauthorized:
return False
@app.exception_handler(Unauthorized)
async def unauthorized_error_handler(_, __):
return JSONResponse({"error": "Unauthorized"}, status_code=401)
@app.exception_handler(RateLimited)
async def rate_limit_error_handler(_, e: RateLimited):
return JSONResponse(
{"error": "RateLimited", "retry": e.retry_after, "message": e.message},
status_code=429,
)
@app.exception_handler(ClientSessionNotInitialized)
async def client_session_error_handler(_, e: ClientSessionNotInitialized):
print(e)
return JSONResponse({"error": "Internal Error"}, status_code=500)
@app.get("/user", dependencies=[Depends(discord.requires_authorization)], response_model=User)
async def get_user(user: User = Depends(discord.user)):
return user
@app.get(
"/guilds",
dependencies=[Depends(discord.requires_authorization)],
response_model=List[GuildPreview],
)
async def get_guilds(guilds: List = Depends(discord.guilds)):
return guilds
```
# Inspired by
[Starlette-Discord](https://github.com/nwunderly/starlette-discord)
[Quart-Discord-OAuth](https://github.com/Tert0/Quart-Discord-OAuth/)
[Quart-Discord](https://github.com/jnawk/quart-discord)
Thanks to @jnawk and @nwunderly