Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

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

Ready-to-use and customizable users management for FastAPI
https://github.com/fastapi-users/fastapi-users

async asyncio fastapi fastapi-users python starlette users

Last synced: 2 months ago
JSON representation

Ready-to-use and customizable users management for FastAPI

Host: GitHub
URL: https://github.com/fastapi-users/fastapi-users
Owner: fastapi-users
License: mit
Created: 2019-10-05T15:40:31.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-04-07T06:17:28.000Z (2 months ago)
Last Synced: 2024-04-08T09:13:43.586Z (2 months ago)
Topics: async, asyncio, fastapi, fastapi-users, python, starlette, users
Language: Python
Homepage: https://fastapi-users.github.io/fastapi-users/
Size: 12.6 MB
Stars: 4,011
Watchers: 41
Forks: 355
Open Issues: 11
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Lists

awesome-fastapi - FastAPI Users - Account management, authentication, authorization. (Third-Party Extensions / Auth)
awesome-starred-test - fastapi-users/fastapi-users - Ready-to-use and customizable users management for FastAPI (Python)
awesome-stars - fastapi-users/fastapi-users - Ready-to-use and customizable users management for FastAPI (Python)
awesome-fastapi - FastAPI Users - Account management, authentication, authorization. (Third-Party Extensions / Auth)
awesome-stars - fastapi-users/fastapi-users - Ready-to-use and customizable users management for FastAPI (Python)
docsify-awesome-stars - fastapi-users/fastapi-users - Ready-to-use and customizable users management for FastAPI (Python)
awesome-fastapi - FastAPI Users - Account management, authentication, authorization. (Third-Party Extensions / Auth)
awesome-stars - fastapi-users/fastapi-users - Ready-to-use and customizable users management for FastAPI (Python)
awesome-stars - fastapi-users - to-use and customizable users management for FastAPI | fastapi-users | 4201 | (Python)

README

        # FastAPI Users



  





    Ready-to-use and customizable users management for FastAPI 



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

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

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

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

[![All Contributors](https://img.shields.io/badge/all_contributors-79-orange.svg?style=flat-square)](#contributors-)





  

  





---

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

## Features

* [X] Extensible base user model

* [X] Ready-to-use register, login, reset password and verify e-mail routes

* [X] Ready-to-use social OAuth2 login flow

* [X] Dependency callables to inject current user in route

* [X] Pluggable password validation

* [X] Customizable database backend

    * [X] [SQLAlchemy ORM async](https://docs.sqlalchemy.org/en/14/orm/extensions/asyncio.html) included

    * [X] [MongoDB with Beanie ODM](https://github.com/roman-right/beanie/) included

* [X] Multiple customizable authentication backends

    * [X] Transports: Authorization header, Cookie

    * [X] Strategies: JWT, Database, Redis

* [X] Full OpenAPI schema support, even with several authentication backends

## In a hurry? Discover Fief, the open-source authentication platform



  





**Implementing registration, login, social auth is hard and painful. We know it. With our highly secure and open-source users management platform, you can focus on your app while staying in control of your users data.**

* Based on **FastAPI Users**!

* **Open-source**: self-host it for free

* **Pre-built login and registration pages**: clean and fast authentication so you don't have to do it yourself

* **Official Python client** with built-in **FastAPI integration**






    



It's free!


## Contributors and sponsors ✨☕️

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_{François Voron}
🚧

      
_{Paolo Dina}
💵 💻

      
_{Dmytro Ohorodnik}
🐛

      
_{Matthew D. Scholefield}
🐛 💻

      
_roywes
🐛 💻

      
_{Satwik Kansal}
📖

      
_{Edd Salkield}
💻 📖

    

    

      
_mark-todd
💻 📖

      
_lill74
🐛 💻 📖

      
_{SelfhostedPro}
🛡️ 💻

      
_{Oskar Gmerek}
📖

      
_{Martin Collado}
🐛 💻

      
_{Eric Lopes}
📖 🛡️

      
_{Beau Breon}
💻

    

    

      
_{Niyas Mohammed}
📖

      
_{prostomarkeloff}
📖 💻

      
_{Marius Mézerette}
🐛 🤔

      
_{Nickolas Grigoriadis}
🐛

      
_{Open Data Coder}
🤔

      
_{Mohammed Alshehri}
🤔

      
_{Tyler Renelle}
🤔

    

    

      
_collerek
💻

      
_{Robert Bracco}
💵

      
_{Augusto Herrmann}
📖

      
_Smithybrewer
🐛

      
_silllli
📖

      
_{alexferrari88}
💵

      
_{sandalwoodbox}
🐛 📖

    

    

      
_{Vlad Hoi}
📖

      
_{Joe Nudell}
🐛

      
_Ben
💻

      
_BoYanZh
📖

      
_{David Brochart}
📖 💻

      
_{Daan Beverdam}
💻

      
_{Stéphane Raimbault}
⚠️ 🐛

    

    

      
_{Sondre Lillebø Gundersen}
📖

      
_Maxim
📖 🐛

      
_scottdavort
💵

      
_{John Dukewich}
📖

      
_{Yasser Tahiri}
💻

      
_{Brandon H. Goding}
💻 📖

      
_PovilasK
💻

    

    

      
_{Just van den Broecke}
💵

      
_jakemanger
🐛 💻

      
_{Ikko Ashimine}
💻

      
_{Matyáš Richter}
💻

      
_Hazedd
🐛 📖

      
_{Luis Roel}
💵

      
_{Alexandr Makurin}
💻 🐛

    

    

      
_{Leon Thurner}
📖

      
_{Goran Mekić}
📦

      
_Gaganpreet
💻

      
_{Joe Taylor}
💻

      
_{Richard Friberg}
🐛

      
_{Kenton Parton}
💵

      
_{Adrian Ciołek}
🐛

    

    

      
_{⭕Alexander Rymdeko-Harvey}
📖

      
_schwannden
🚧 💻

      
_{Jimmy Angel Pérez Díaz}
🛡️

      
_{Austin Orr}
🚧

      
_{Carlo Eugster}
🛡️

      
_{Vittorio Zamboni}
💻

      
_Andrey
📖

    

    

      
_{Can H. Tartanoglu}
🐛

      
_{Filipe Nascimento}
🛡️

      
_dudulu
💵 🐛 💬

      
_{Toni Alatalo}
💻 📖

      
_{Börge Kiss}
📖

      
_{Guilherme Caminha}
📖

      
_{Téva KRIEF}
💻

    

    

      
_{Essa Alshammri}
📖

      
_0xJan
🐛

      
_{Justin Thomas}
💻

      
_{Adam Israel}
💻

      
_Nerixjk
🐛 💻

      
_{Mike Fotinakis}
💻 🐛

      
_lifengmds
💵

    

    

      
_raindata5
📖

      
_{Mark Donnelly}
📖

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## Development

### Setup environment

We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system.

### Run unit tests

You can run all the tests with:

```bash

hatch run test:test

```

### Format the code

Execute the following command to apply linting and check typing:

```bash

hatch run lint

```

### Serve the documentation

You can serve the documentation locally with the following command:

```bash

hatch run docs

```

The documentation will be available on [http://localhost:8000](http://localhost:8000).

## License

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