README.md

FastAPI Users - Database adapter for SQLModel

Ready-to-use and customizable users management for FastAPI

---

Documentation: https://fastapi-users.github.io/fastapi-users/

Source Code: https://github.com/fastapi-users/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.

Sub-package for SQLModel support in FastAPI Users.

Development

Setup environment

Hatch is a project management tool used for environments and dependencies.

Install needed dependencies:

hatch run pip install -e .

Get more information about Hatch:

hatch --help

Run unit tests

To run all unit tests for the project execute:

hatch run test

There are quite a few unit tests, so you might run into ulimit issues where there are too many open file descriptors. You may be able to set a new, higher limit temporarily with:

ulimit -n 2048

Format the code

Execute the following command to apply isort and black formatting:

hatch run lint

License

This project is licensed under the terms of the MIT license.