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-1.1.0.tar.gz (90.5 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-1.1.0-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fastapi-users-1.1.0.tar.gz
Algorithm Hash digest
SHA256 245aabf88e458ae401895d4f4f30b49500593012364bb8c0b72700e2070a9567
MD5 373ddbba6aafc4c4cbcc883de18b5f4f
BLAKE2b-256 3b5f4355e884a2c7f1043c353cebf9e06346856733e9c68f6336da9e13309d11

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for fastapi_users-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ad59072cfa5aaf13b59a6128fb32435f8e5dd6d5ac6f8103cef320be0a3ad93
MD5 873c25c47d1bb781f097a4ded8b0880e
BLAKE2b-256 c802a3574368edb07a9e69e69c5004afa86962f43a7ed492572871b4ab5b546d

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