lynxye / authx Goto Github PK

View Code? Open in Web Editor NEW

This project forked from yezz123/authx

0.0 0.0 0.0 1.52 MB

Ready-to-use and customizable Authentications and Oauth2 management for FastAPI ✨

Home Page: https://authx.yezz.me/

License: MIT License

Shell 1.96% Python 98.04%

authx's Introduction

AuthenticationX 💫

Ready-to-use and customizable Authentications and Oauth2 management for FastAPI ⚡

Source Code: https://github.com/yezz123/authx

Documentation: https://authx.yezz.me/

Add a Fully registration and authentication or authorization system to your FastAPI project. AuthX is designed to be as customizable and adaptable as possible.

Authx V0.9.x

This branch relates to development of authx V1 which is not yet ready for production use.

If you're a Authx user, you probably want either Authx V0.9 Documentation or, 0.X.X-fix git branch.

Features 🔧

Note: Check Release Notes.

Project using 🚀

Here is a simple way to kickstart your project with AuthX:

from fastapi import FastAPI, Depends, HTTPException
from authx import AuthX, AuthXConfig, RequestToken

app = FastAPI()

config = AuthXConfig(
     JWT_ALGORITHM = "HS256",
     JWT_SECRET_KEY = "SECRET_KEY",
     JWT_TOKEN_LOCATION = ["headers"],
)

auth = AuthX(config=config)
auth.handle_errors(app)

@app.get('/login')
def login(username: str, password: str):
     if username == "xyz" and password == "xyz":
          token = auth.create_access_token(uid=username)
          return {"access_token": token}
     raise HTTPException(401, detail={"message": "Invalid credentials"})

@app.get("/protected", dependencies=[Depends(auth.get_token_from_request)])
def get_protected(token: RequestToken = Depends()):
     try:
          auth.verify_token(token=token)
          return {"message": "Hello world !"}
     except Exception as e:
          raise HTTPException(401, detail={"message": str(e)}) from e

Contributors and sponsors ✨☕️

Thanks goes to these wonderful people (emoji key):

_{Yasser Tahiri} 💻 📖 🚧 🚇	_{Abderrahim SOUBAI-ELIDRISI} 👀 📖	_{Ismail Ghallou} 💻 🛡️	_{talentuno LLC} 💵	_{Cactus LLC} 💵	_MojixCoder 💻 🐛	_{Stéphane Raimbault} 💻 🔌
_theoohoho 📖	_{Yogesh Upadhyay} 🐛	_Roman 🐛	_{Alvaro Lopez Ortega} 📖