https://github.com/fastapi-users/fastapi-users-db-tortoise

FastAPI Users - Database adapter for Tortoise ORM
https://github.com/fastapi-users/fastapi-users-db-tortoise

fastapi-users

Last synced: 6 days ago
JSON representation

FastAPI Users - Database adapter for Tortoise ORM

• Host: GitHub
• URL: https://github.com/fastapi-users/fastapi-users-db-tortoise
• Owner: fastapi-users
• License: mit
• Created: 2021-08-26T12:13:47.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-11T04:43:19.000Z (over 1 year ago)
• Last Synced: 2023-12-17T09:02:24.123Z (11 months ago)
• Topics: fastapi-users
• Language: Python
• Homepage:
• Size: 42 KB
• Stars: 8
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# FastAPI Users - Database adapter for Tortoise ORM



  





    Ready-to-use and customizable users management for FastAPI



[![build](https://github.com/fastapi-users/fastapi-users-db-tortoise/workflows/Build/badge.svg)](https://github.com/fastapi-users/fastapi-users/actions)

[![codecov](https://codecov.io/gh/fastapi-users/fastapi-users-db-tortoise/branch/master/graph/badge.svg)](https://codecov.io/gh/fastapi-users/fastapi-users-db-tortoise)

[![PyPI version](https://badge.fury.io/py/fastapi-users-db-tortoise.svg)](https://badge.fury.io/py/fastapi-users-db-tortoise)

[![Downloads](https://pepy.tech/badge/fastapi-users-db-tortoise)](https://pepy.tech/project/fastapi-users-db-tortoise)







---

**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](https://fastapi.tiangolo.com/) project. **FastAPI Users** is designed to be as customizable and adaptable as possible.

**Sub-package for Tortoise ORM support in FastAPI Users.**

## Development

### Setup environment

You should create a virtual environment and activate it:

```bash

python -m venv venv/

```

```bash

source venv/bin/activate

```

And then install the development dependencies:

```bash

pip install -r requirements.dev.txt

```

### Run unit tests

You can run all the tests with:

```bash

make test

```

Alternatively, you can run `pytest` yourself:

```bash

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:

```bash

ulimit -n 2048

```

### Format the code

Execute the following command to apply `isort` and `black` formatting:

```bash

make format

```

## License

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