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

Uploaded Source

Built Distribution

fastapi_users-3.0.1-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fastapi-users-3.0.1.tar.gz
Algorithm Hash digest
SHA256 a52ef41d6bb16295990c68df4caaeeb6fc61d05d2b7ffbb9ad695802d2fec76f
MD5 0bf63fbe216b43df09c86a4a74f766b2
BLAKE2b-256 0cc06ca58a253934588d85ac37af8ab223bc4946a3d67d1d9e6425ba6cf2a791

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fastapi_users-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 134c8e9f232410b0131afbaf47b4eaf35dfdea255ef3e7dc4a9ef244a7f232dc
MD5 137ed25b4bd34c99a8ffee7e16f9ae46
BLAKE2b-256 7d8a10999a7944afc1e4c86cf75a5242955aff87a60b484b9fcc181aff18b2e4

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