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 Dependabot Status 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-2.0.1.tar.gz (91.8 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-2.0.1-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fastapi-users-2.0.1.tar.gz
Algorithm Hash digest
SHA256 542f89b53d102ee8e70ab0423a8cb5974e2d90159cd91a5c9277b672ecf27025
MD5 c8eda46c28f171779643f17fcd3de946
BLAKE2b-256 fbc5fd5218066c2969ff5b8d1b718b9ed257aff0bb56c5a58402d5398574fcf1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for fastapi_users-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a25f31f57e3fc6e78243dd50220a9af2fc2c79a8b11a3804cda23b04bc16e8a9
MD5 7474ef085d9e3ba326a66f7327a4ab76
BLAKE2b-256 cdb147a068d8e3723050b47d3cc0ceb4345a8334bde7a496cd8f49f9e0e87f16

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