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

FastAPI Users - Database adapter for ormar
https://github.com/fastapi-users/fastapi-users-db-ormar

fastapi-users

Last synced: 6 days ago
JSON representation

FastAPI Users - Database adapter for ormar

• Host: GitHub
• URL: https://github.com/fastapi-users/fastapi-users-db-ormar
• Owner: fastapi-users
• License: mit
• Created: 2021-08-27T13:52:39.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-24T04:28:26.000Z (about 2 years ago)
• Last Synced: 2023-11-20T15:44:33.699Z (12 months ago)
• Topics: fastapi-users
• Language: Python
• Homepage:
• Size: 24.4 KB
• Stars: 6
• Watchers: 3
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# FastAPI Users - Database adapter for ormar



  





    Ready-to-use and customizable users management for FastAPI



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

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

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

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







---

**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 ormar 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.