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.1.tar.gz (90.5 kB view details)

Uploaded Source

Built Distribution

fastapi_users-1.1.1-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi-users-1.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 864fc59730853f9d61181c198a22e98e876d17a58bbc7af4b264b6424fd599d0
MD5 b48737df24e01e8ac2dd98d00682f590
BLAKE2b-256 1c72fe3f258162d19b191263220318bf7117aecb82a49cadf857b31154256e86

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fastapi_users-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7eca3b7605a3b0c7e71552f8baeacf98fda7556b7c7f4c09fcaae28edb7ec341
MD5 c3e3e7152fd3d4cef77ab72d13595094
BLAKE2b-256 81e8cf1ad4008ec56d37963daf781443d9d3da78e9576f9bf31dc3c9ae27a4ae

See more details on using hashes here.

Supported by

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