README.md

FastAPI Users - Database adapter for Tortoise ORM

Tortoise orm database adapter for fastapi-users v10 and above. If you want an example of a project using this or just bootstrap your project with fastapi-users and tortoise, you can check out the cookiecutter I'm working on here.

---

Documentation: https://tobi-de.github.io/fastapi-users-tortoise

Source Code: https://github.com/tobi-de/fastapi-users-tortoise

---

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 Tortoise ORM support in FastAPI Users.

Installation

pip install fastapi-users-tortoise

Development

Setup environment

You should create a virtual environment and activate it:

python -m venv venv/

source venv/bin/activate

And then install the development dependencies:

pip install -r requirements.dev.txt

Run unit tests

You can run all the tests with:

make test

Alternatively, you can run pytest yourself:

pytest

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:

make format

License

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