Skip to main content

Ready-to-use and customizable users management for FastAPI.

Project description

FastAPI Users

FastAPI Users

Ready-to-use and customizable users management for FastAPI

build codecov PyPI version Downloads


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
  • 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

fastapi-users-3.1.0.tar.gz (96.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastapi_users-3.1.0-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file fastapi-users-3.1.0.tar.gz.

File metadata

  • Download URL: fastapi-users-3.1.0.tar.gz
  • Upload date:
  • Size: 96.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.0

File hashes

Hashes for fastapi-users-3.1.0.tar.gz
Algorithm Hash digest
SHA256 d389354d61c9af1ef148d789ff618bed5696fb887c118b3aaae90e1e424e7709
MD5 8b67e6c60afdef0a15120452ba43d2d8
BLAKE2b-256 cd530efea7a83e5ed4aa76eaecd22ba46cb68f15d56cb3c697a33e7f8501af4c

See more details on using hashes here.

File details

Details for the file fastapi_users-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: fastapi_users-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.0

File hashes

Hashes for fastapi_users-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8756fc504049058639121144da8bca99ec77950b9c0293fb62270857c5b45572
MD5 87357d86740b2bdc7e7fee6829bda04f
BLAKE2b-256 fc907303f533e88afc9e491c062b9343bd3be24fa45a6974670b7efa0075e71d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page