Files
fastapi-users/README.md
François Voron a5618399a1 Fix #9: Write documentation (#16)
* Start to write documentation

* Add docs favicon

* Add routes documentation

* Add doc about dependency callables

* Add information about how to make authenticated calls
2019-10-19 18:16:08 +02:00

37 lines
1.5 KiB
Markdown

# FastAPI Users
<p align="center">
<img src="https://raw.githubusercontent.com/frankie567/fastapi-users/master/logo.svg?sanitize=true" alt="FastAPI Users">
</p>
<p align="center">
<em>Ready-to-use and customizable users management for FastAPI </em>
</p>
[![build](https://github.com/frankie567/fastapi-users/workflows/Build/badge.svg)](https://github.com/frankie567/fastapi-users/actions)
[![codecov](https://codecov.io/gh/frankie567/fastapi-users/branch/master/graph/badge.svg)](https://codecov.io/gh/frankie567/fastapi-users)
[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=frankie567/fastapi-users)](https://dependabot.com)
[![PyPI version](https://badge.fury.io/py/fastapi-users.svg)](https://badge.fury.io/py/fastapi-users)
---
**Documentation**: <a href="https://frankie567.github.io/fastapi-users/" target="_blank">https://frankie567.github.io/fastapi-users/</a>
**Source Code**: <a href="https://github.com/frankie567/fastapi-users" target="_blank">https://github.com/frankie567/fastapi-users</a>
---
## Work in progress 🚧
This library is currently in early stage development. First working version soon!
## Features
* Extensible base user model
* Ready-to-use register, login, forgot and reset password routes.
* Customizable database backend
* SQLAlchemy backend included
* *MongoDB backend included ([#4](https://github.com/frankie567/fastapi-users/issues/4))*
* Customizable authentication backend
* JWT authentication backend included