SelfhostedPro/fastapi-users

Ready-to-use and customizable users management for FastAPI

FastAPI Users

Ready-to-use and customizable users management for FastAPI

---

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

Source Code: https://github.com/frankie567/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, forgot and reset password routes
• Ready-to-use OAuth2 flow
• Dependency callables to inject current user in route
• Customizable database backend
  • SQLAlchemy async backend included thanks to encode/databases
  • MongoDB async backend included thanks to mongodb/motor
  • Tortoise ORM backend included
• Multiple customizable authentication backends
  • JWT authentication backend included
  • Cookie authentication backend included
• Full OpenAPI schema support, even with several authentication backends

Development

Setup environement

You should have Pipenv installed. Then, you can install the dependencies with:

pipenv install --dev

After that, activate the virtual environment:

pipenv shell

Run unit tests

You can run all the tests with:

make test

The command will start a MongoDB container for the related unit tests. So you should have Docker installed.

Alternatively, you can run pytest yourself. The MongoDB unit tests will be skipped if no server is available on your local machine:

pytest

Format the code

Execute the following command to apply isort and black formatting:

make format

License

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