fastapi-users 15.0.4

Ready-to-use and customizable users management for FastAPI

FastAPI Users

Ready-to-use and customizable users management for FastAPI

[!NOTE] This project is now in maintenance mode. While we'll continue to provide security updates and dependency maintenance, no new features will be added. We encourage you to explore the project and use it as-is, knowing it will remain stable and secure.

We're currently working on a new Python authentication toolkit that will ultimately supersede FastAPI Users. Stay tuned for updates!

---

Documentation: https://fastapi-users.github.io/fastapi-users/

Source Code: https://github.com/fastapi-users/fastapi-users

---

Add quickly a registration and authentication system to your FastAPI project. FastAPI Users is designed to be as customizable and adaptable as possible.

Features

• Extensible base user model
• Ready-to-use register, login, reset password and verify e-mail routes
• Ready-to-use social OAuth2 login flow
• Dependency callables to inject current user in route
• Pluggable password validation
• Customizable database backend
  • SQLAlchemy ORM async included
  • MongoDB with Beanie ODM included
• Multiple customizable authentication backends
  • Transports: Authorization header, Cookie
  • Strategies: JWT, Database, Redis
• Full OpenAPI schema support, even with several authentication backends

Contributors and sponsors ✨☕️

Thanks goes to these wonderful people (emoji key):

François Voron 🚧	Paolo Dina 💵 💻	Dmytro Ohorodnik 🐛	Matthew D. Scholefield 🐛 💻	roywes 🐛 💻	Satwik Kansal 📖	Edd Salkield 💻 📖
mark-todd 💻 📖	lill74 🐛 💻 📖	SelfhostedPro 🛡️ 💻	Oskar Gmerek 📖	Martin Collado 🐛 💻	Eric Lopes 📖 🛡️	Beau Breon 💻
Niyas Mohammed 📖	prostomarkeloff 📖 💻	Marius Mézerette 🐛 🤔	Nickolas Grigoriadis 🐛	Open Data Coder 🤔	Mohammed Alshehri 🤔	Tyler Renelle 🤔
collerek 💻	Robert Bracco 💵	Augusto Herrmann 📖	Smithybrewer 🐛	silllli 📖	alexferrari88 💵	sandalwoodbox 🐛 📖
Vlad Hoi 📖	Joe Nudell 🐛	Ben 💻	BoYanZh 📖	David Brochart 📖 💻	Daan Beverdam 💻	Stéphane Raimbault ⚠️ 🐛
Sondre Lillebø Gundersen 📖	Maxim 📖 🐛	scottdavort 💵	John Dukewich 📖	Yasser Tahiri 💻	Brandon H. Goding 💻 📖	PovilasK 💻
Just van den Broecke 💵	jakemanger 🐛 💻	Ikko Ashimine 💻	Matyáš Richter 💻	Hazedd 🐛 📖	Luis Roel 💵	Alexandr Makurin 💻 🐛
Leon Thurner 📖	Goran Mekić 📦	Gaganpreet 💻	Joe Taylor 💻	Richard Friberg 🐛	Kenton Parton 💵	Adrian Ciołek 🐛
⭕Alexander Rymdeko-Harvey 📖	schwannden 🚧 💻	Jimmy Angel Pérez Díaz 🛡️	Austin Orr 🚧	Carlo Eugster 🛡️	Vittorio Zamboni 💻	Andrey 📖
Can H. Tartanoglu 🐛	Filipe Nascimento 🛡️	dudulu 💵 🐛 💬	Toni Alatalo 💻 📖	Börge Kiss 📖	Guilherme Caminha 📖	Téva KRIEF 💻
Essa Alshammri 📖	0xJan 🐛	Justin Thomas 💻	Adam Israel 💻	Nerixjk 🐛 💻	Mike Fotinakis 💻 🐛	lifengmds 💵
raindata5 📖	Mark Donnelly 📖	Alexander Zinov 💻	nimaxin 📖	Muhammad Daffa Dinaya 🐛	Joschka Thurner 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

Development

Setup environment

We use Hatch to manage the development environment and production build. Ensure it's installed on your system.

Run unit tests

You can run all the tests with:

hatch run test

Format the code

Execute the following command to apply linting and check typing:

hatch run lint

Serve the documentation

You can serve the documentation locally with the following command:

hatch run docs

The documentation will be available on http://localhost:8000.

License

This project is licensed under the terms of the MIT license.