AuthenticationX
π«
Ready-to-use and customizable Authentications and Oauth2 management for FastAPI
Source Code: https://github.com/yezz123/AuthX
Documentation: https://authx.yezz.codes/
Add a Fully registration and authentication or authorization system to your FastAPI project. AuthX is designed to be as customizable and adaptable as possible.
Note: This is a beta version of AuthX.
Features
π§
- Support Python 3.8+.
- Extensible base user model.
- Ready-to-use register, login, reset password and verify e-mail routes.
- Ready-to-use Social login and Oauth2 routes. (now with Google, Facebook)
- Soon with Microsoft, Twitter, Github, etc.
- Ready-to-use social OAuth2 login flow
- Dependency callable to inject current user in route
- Pluggable password validation
- Using Captcha Service.
- Using Email Service. (SMTP)
- Extensible Error Handling
- High level API to manage users, roles and permissions
- Using Redis as a session store & cache.
- Customizable database backend:
- MongoDB async backend included thanks to mongodb/motor
- Multiple customizable authentication backend:
- JWT authentication backend included
- Soon to be included Cookie authentication backend
- Full OpenAPI schema support, even with several authentication backend.
- Provide a Docstring for each class and function.
Note: Check Release Notes.
Project using
π
from fastapi import FastAPI
from authx import Authentication
app = FastAPI()
auth = Authentication()
# Define your routes here
app.include_router(auth.auth_router, prefix="/api/users")
app.include_router(auth.social_router, prefix="/auth")
app.include_router(auth.password_router, prefix="/api/users")
app.include_router(auth.admin_router, prefix="/api/users")
app.include_router(auth.search_router, prefix="/api/users")
Startup
π
from fastapi import FastAPI
from authx import Authentication
from authx.database import MongoDBBackend, RedisBackend
app = FastAPI()
auth = Authentication()
app.include_router(auth.auth_router, prefix="/api/users")
app.include_router(auth.social_router, prefix="/auth")
app.include_router(auth.password_router, prefix="/api/users")
app.include_router(auth.admin_router, prefix="/api/users")
app.include_router(auth.search_router, prefix="/api/users")
# Set MongoDB and Redis Cache
auth.set_cache(RedisBackend) # aioredis client
auth.set_database(MongoDBBackend) # motor client
Dependency injections
π¦
from fastapi import FastAPI,APIRouter, Depends
from authx import User, Authentication
from authx.database import MongoDBBackend, RedisBackend
app = FastAPI()
auth = Authentication()
router = APIRouter()
app.include_router(auth.auth_router, prefix="/api/users")
app.include_router(auth.social_router, prefix="/auth")
app.include_router(auth.password_router, prefix="/api/users")
app.include_router(auth.admin_router, prefix="/api/users")
app.include_router(auth.search_router, prefix="/api/users")
# Set MongoDB and Redis Cache
auth.set_cache(RedisBackend) # aioredis client
auth.set_database(MongoDBBackend) # motor client
# Set Anonymous User
@router.get("/anonym")
def anonym_test(user: User = Depends(auth.get_user)):
pass
# Set Authenticated User
@router.get("/user")
def user_test(user: User = Depends(auth.get_authenticated_user)):
pass
# Set Admin User
@router.get("/admin", dependencies=[Depends(auth.admin_required)])
def admin_test():
pass
Dependency injections only
π¦
from authx import authx
from authx.database import RedisBackend
auth = authx(#Provide Config)
# startup
auth.set_cache(RedisBackend) # aioredis
Development
π§
Setup environment
π¦
You should create a virtual environment and activate it:
python -m venv venv/
source venv/bin/activate
And then install the development dependencies:
pip install -r requirements.dev.txt
Run tests
π
I use Pytest to run the tests, you can run this by using a shortcut command in the Makefile:
make test
Format the code
π
Execute the following command to apply pre-commit formatting:
make lint
Contributors and sponsors
β¨
βοΈ
Thanks goes to these wonderful people (emoji key):
 Yasser Tahiri |
 Abderrahim SOUBAI-ELIDRISI |
 Ismail Ghallou |
 talentuno LLC |
 Cactus LLC |
 MojixCoder |
This project follows the all-contributors specification. Contributions of any kind welcome!
License
π
This project is licensed under the terms of the MIT License.
6 Dec 12, 2021
4 Jan 29, 2022
468 Jan 01, 2023
1.6k Dec 08, 2022
73 Dec 03, 2021
3.4k Jan 04, 2023
1.2k Dec 28, 2022
23 Aug 01, 2022
1.1k Jan 03, 2023
3 Aug 18, 2022
1 Jan 02, 2022
12 Aug 22, 2019
1 Jan 13, 2022
1k Dec 28, 2022
915 Dec 28, 2022
11 Dec 11, 2022
178 Jan 02, 2023
11 Nov 20, 2022
315 Dec 25, 2022
5 Dec 02, 2022