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

Buy Me A Coffee


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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fastapi-users-4.0.0.tar.gz
Algorithm Hash digest
SHA256 66612a238dc3ae02a9f01523054974db22bdaa809336d27155383c288b17234c
MD5 eccec4e63e6590559149afbbd023eac6
BLAKE2b-256 4ad465c8560bca3d92656c87d89d15d016bed75e54f9d649c3f298a57b854bad

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fastapi_users-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0abd1524183896cb7d721dbc93f901d256647b08da7be9f0190e1e1f6760b70d
MD5 ef350f63a22f39492f8ba09afede0261
BLAKE2b-256 fe8505ac94937dac9e71136a2c95135133369d5c3f4437769c6b9dfed99fa5b2

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