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

Uploaded Source

Built Distribution

fastapi_users-3.1.2-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fastapi-users-3.1.2.tar.gz
Algorithm Hash digest
SHA256 e07234b1dbe0b55d15475ae32ffd863c02a1c9e81b1e6078820c8fdc7bcf059d
MD5 24bb53199b643fc9f73dbef62aa1c52c
BLAKE2b-256 a81ccb4b6bee2fca535d81efc4f58fec1db976ae30fbd2ea7c216ca823713438

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fastapi_users-3.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a625d339a32bb89d83282c12d5f473b7a6ede8d8c754fa47bad1014a1cbd4247
MD5 dae6c0301c2d5957ec2eb1eded8d2135
BLAKE2b-256 ddbdcda9484abb0905aecd1909e84203cd755906d0c4a0835b04c2d8310c0525

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