Ready-to-use and customizable users management for FastAPI.
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fastapi-users-2.0.0.tar.gz
.
File metadata
- Download URL: fastapi-users-2.0.0.tar.gz
- Upload date:
- Size: 91.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.23.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe9cfe8b4de78066b7eff00171d32b7bb04a42014a0c4a28e0bae78840e0debb |
|
MD5 | a8bc76cf67c8cdd29673295a65c5b043 |
|
BLAKE2b-256 | ea64f65b697bb8cc1f0771acfc78b296dcdccf3698ce730840ea89b76addf10f |
File details
Details for the file fastapi_users-2.0.0-py3-none-any.whl
.
File metadata
- Download URL: fastapi_users-2.0.0-py3-none-any.whl
- Upload date:
- Size: 22.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.23.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 544dc1d5f7512dabb0e6a9936338728e7613c4a48aeecc8345f8ed01a4ddbcd4 |
|
MD5 | fbdeb157cfb859f190c8d173c0b7c7f7 |
|
BLAKE2b-256 | 927f05fd280c5dc842d95b83e81fe7f232b3f6676b3731eb27a1914f2250c4b5 |