Ready-to-use and customizable users management for FastAPI
[](https://github.com/frankie567/fastapi-users/actions) [](https://codecov.io/gh/frankie567/fastapi-users) [](https://dependabot.com) [](https://badge.fury.io/py/fastapi-users) --- **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](https://fastapi.tiangolo.com/) project. **FastAPI Users** is designed to be as customizable and adaptable as possible. ## Features * [X] Extensible base user model * [X] Ready-to-use register, login, forgot and reset password routes. * [X] Dependency callables to inject current user in route. * [X] Customizable database backend * [X] SQLAlchemy async backend included thanks to [encode/databases](https://www.encode.io/databases/) * [X] MongoDB async backend included thanks to [mongodb/motor](https://github.com/mongodb/motor) * [X] Customizable authentication backend * [X] JWT authentication backend included ## Development ### Setup environement You should have [Pipenv](https://pipenv.readthedocs.io/en/latest/) installed. Then, you can install the dependencies with: ```bash pipenv install --dev ``` After that, activate the virtual environment: ```bash pipenv shell ``` ### Run unit tests You can run all the tests with: ```bash make test ``` The command will start a MongoDB container for the related unit tests. So you should have [Docker](https://www.docker.com/get-started) installed. Alternatively, you can run `pytest` yourself. The MongoDB unit tests will be skipped if no server is available on your local machine: ```bash pytest ``` ### Format the code Execute the following command to apply `isort` and `black` formatting: ```bash make format ``` ## License This project is licensed under the terms of the MIT license.