python/fastapi-users
1
0
Fork 0
mirror of https://github.com/fastapi-users/fastapi-users.git synced 2026-03-13 07:49:55 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
3898008b4508c3201ebafde88bc53b592d7e18f8
fastapi-users/index.html

747 lines
21 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="description" content="Ready-to-use and customizable users management for FastAPI">
<link rel="shortcut icon" href="favicon.png">
<meta name="generator" content="mkdocs-1.1, mkdocs-material-5.0.0b2-1">
<title>FastAPI Users</title>
<link rel="stylesheet" href="assets/stylesheets/app.0f079138.min.css">
<link rel="stylesheet" href="assets/stylesheets/app-palette.3f90c815.min.css">
<meta name="theme-color" content="#ef5350">
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
</head>
<body dir="ltr" data-md-color-primary="red" data-md-color-accent="red">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<a href="#fastapi-users" class="md-skip">
Skip to content
</a>
<header class="md-header" data-md-component="header">
<nav class="md-header-nav md-grid">
<div class="md-flex">
<div class="md-flex__cell md-flex__cell--shrink">
<a href="." title="FastAPI Users" aria-label="FastAPI Users" class="md-header-nav__button md-logo">
<i class="md-icon">supervisor_account</i>
</a>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
</div>
<div class="md-flex__cell md-flex__cell--stretch">
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="header-title">
<span class="md-header-nav__topic">
FastAPI Users
</span>
<span class="md-header-nav__topic">
About
</span>
</div>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
<label class="md-icon md-search__icon" for="__search"></label>
<button type="reset" class="md-icon md-search__icon" data-md-component="search-reset" tabindex="-1">
&#xE5CD;
</button>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Type to start searching
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<div class="md-header-nav__source">
<a href="https://github.com/frankie567/fastapi-users" title="Go to repository" class="md-source">
<div class="md-source__icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
frankie567/fastapi-users
</div>
</a>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" data-md-level="0">
<label class="md-nav__title md-nav__title--site" for="__drawer">
<a href="." title="FastAPI Users" class="md-nav__button md-logo">
<i class="md-icon">supervisor_account</i>
</a>
FastAPI Users
</label>
<div class="md-nav__source">
<a href="https://github.com/frankie567/fastapi-users" title="Go to repository" class="md-source">
<div class="md-source__icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
frankie567/fastapi-users
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
About
</label>
<a href="." title="About" class="md-nav__link md-nav__link--active">
About
</a>
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#features" class="md-nav__link">
Features
</a>
</li>
<li class="md-nav__item">
<a href="#development" class="md-nav__link">
Development
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#setup-environement" class="md-nav__link">
Setup environement
</a>
</li>
<li class="md-nav__item">
<a href="#run-unit-tests" class="md-nav__link">
Run unit tests
</a>
</li>
<li class="md-nav__item">
<a href="#format-the-code" class="md-nav__link">
Format the code
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#license" class="md-nav__link">
License
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="installation/" title="Installation" class="md-nav__link">
Installation
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
<label class="md-nav__link" for="nav-3">
Configuration
</label>
<nav class="md-nav" data-md-level="1">
<label class="md-nav__title" for="nav-3">
Configuration
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="configuration/model/" title="User model" class="md-nav__link">
User model
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-2" type="checkbox" id="nav-3-2">
<label class="md-nav__link" for="nav-3-2">
Databases
</label>
<nav class="md-nav" data-md-level="2">
<label class="md-nav__title" for="nav-3-2">
Databases
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="configuration/databases/sqlalchemy/" title="SQLAlchemy" class="md-nav__link">
SQLAlchemy
</a>
</li>
<li class="md-nav__item">
<a href="configuration/databases/mongodb/" title="MongoDB" class="md-nav__link">
MongoDB
</a>
</li>
<li class="md-nav__item">
<a href="configuration/databases/tortoise/" title="Tortoise ORM" class="md-nav__link">
Tortoise ORM
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-3" type="checkbox" id="nav-3-3">
<label class="md-nav__link" for="nav-3-3">
Authentication
</label>
<nav class="md-nav" data-md-level="2">
<label class="md-nav__title" for="nav-3-3">
Authentication
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="configuration/authentication/" title="Introduction" class="md-nav__link">
Introduction
</a>
</li>
<li class="md-nav__item">
<a href="configuration/authentication/jwt/" title="JWT" class="md-nav__link">
JWT
</a>
</li>
<li class="md-nav__item">
<a href="configuration/authentication/cookie/" title="Cookie" class="md-nav__link">
Cookie
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="configuration/router/" title="Router" class="md-nav__link">
Router
</a>
</li>
<li class="md-nav__item">
<a href="configuration/full_example/" title="Full example" class="md-nav__link">
Full example
</a>
</li>
<li class="md-nav__item">
<a href="configuration/oauth/" title="OAuth2" class="md-nav__link">
OAuth2
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
<label class="md-nav__link" for="nav-4">
Usage
</label>
<nav class="md-nav" data-md-level="1">
<label class="md-nav__title" for="nav-4">
Usage
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="usage/routes/" title="Routes" class="md-nav__link">
Routes
</a>
</li>
<li class="md-nav__item">
<a href="usage/dependency-callables/" title="Dependency callables" class="md-nav__link">
Dependency callables
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#features" class="md-nav__link">
Features
</a>
</li>
<li class="md-nav__item">
<a href="#development" class="md-nav__link">
Development
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#setup-environement" class="md-nav__link">
Setup environement
</a>
</li>
<li class="md-nav__item">
<a href="#run-unit-tests" class="md-nav__link">
Run unit tests
</a>
</li>
<li class="md-nav__item">
<a href="#format-the-code" class="md-nav__link">
Format the code
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#license" class="md-nav__link">
License
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content">
<article class="md-content__inner md-typeset">
<h1 id="fastapi-users">FastAPI Users<a class="headerlink" href="#fastapi-users" title="Permanent link">&para;</a></h1>
<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>
<p><a href="https://github.com/frankie567/fastapi-users/actions"><img alt="build" src="https://github.com/frankie567/fastapi-users/workflows/Build/badge.svg" /></a>
<a href="https://codecov.io/gh/frankie567/fastapi-users"><img alt="codecov" src="https://codecov.io/gh/frankie567/fastapi-users/branch/master/graph/badge.svg" /></a>
<a href="https://dependabot.com"><img alt="Dependabot Status" src="https://api.dependabot.com/badges/status?host=github&amp;repo=frankie567/fastapi-users" /></a>
<a href="https://badge.fury.io/py/fastapi-users"><img alt="PyPI version" src="https://badge.fury.io/py/fastapi-users.svg" /></a></p>
<hr />
<p><strong>Documentation</strong>: <a href="https://frankie567.github.io/fastapi-users/" target="_blank">https://frankie567.github.io/fastapi-users/</a></p>
<p><strong>Source Code</strong>: <a href="https://github.com/frankie567/fastapi-users" target="_blank">https://github.com/frankie567/fastapi-users</a></p>
<hr />
<p>Add quickly a registration and authentication system to your <a href="https://fastapi.tiangolo.com/">FastAPI</a> project. <strong>FastAPI Users</strong> is designed to be as customizable and adaptable as possible.</p>
<h2 id="features">Features<a class="headerlink" href="#features" title="Permanent link">&para;</a></h2>
<ul class="task-list">
<li class="task-list-item"><input type="checkbox" disabled checked/> Extensible base user model</li>
<li class="task-list-item"><input type="checkbox" disabled checked/> Ready-to-use register, login, forgot and reset password routes</li>
<li class="task-list-item"><input type="checkbox" disabled checked/> Ready-to-use OAuth2 flow</li>
<li class="task-list-item"><input type="checkbox" disabled checked/> Dependency callables to inject current user in route</li>
<li class="task-list-item"><input type="checkbox" disabled checked/> Customizable database backend<ul class="task-list">
<li class="task-list-item"><input type="checkbox" disabled checked/> SQLAlchemy async backend included thanks to <a href="https://www.encode.io/databases/">encode/databases</a></li>
<li class="task-list-item"><input type="checkbox" disabled checked/> MongoDB async backend included thanks to <a href="https://github.com/mongodb/motor">mongodb/motor</a></li>
<li class="task-list-item"><input type="checkbox" disabled checked/> <a href="https://tortoise-orm.readthedocs.io/en/latest/">Tortoise ORM</a> backend included</li>
</ul>
</li>
<li class="task-list-item"><input type="checkbox" disabled checked/> Multiple customizable authentication backends<ul class="task-list">
<li class="task-list-item"><input type="checkbox" disabled checked/> JWT authentication backend included</li>
<li class="task-list-item"><input type="checkbox" disabled checked/> Cookie authentication backend included</li>
</ul>
</li>
</ul>
<h2 id="development">Development<a class="headerlink" href="#development" title="Permanent link">&para;</a></h2>
<h3 id="setup-environement">Setup environement<a class="headerlink" href="#setup-environement" title="Permanent link">&para;</a></h3>
<p>You should have <a href="https://pipenv.readthedocs.io/en/latest/">Pipenv</a> installed. Then, you can install the dependencies with:</p>
<div class="highlight"><pre><span></span><code>pipenv install --dev
</code></pre></div>
<p>After that, activate the virtual environment:</p>
<div class="highlight"><pre><span></span><code>pipenv shell
</code></pre></div>
<h3 id="run-unit-tests">Run unit tests<a class="headerlink" href="#run-unit-tests" title="Permanent link">&para;</a></h3>
<p>You can run all the tests with:</p>
<div class="highlight"><pre><span></span><code>make <span class="nb">test</span>
</code></pre></div>
<p>The command will start a MongoDB container for the related unit tests. So you should have <a href="https://www.docker.com/get-started">Docker</a> installed.</p>
<p>Alternatively, you can run <code>pytest</code> yourself. The MongoDB unit tests will be skipped if no server is available on your local machine:</p>
<div class="highlight"><pre><span></span><code>pytest
</code></pre></div>
<h3 id="format-the-code">Format the code<a class="headerlink" href="#format-the-code" title="Permanent link">&para;</a></h3>
<p>Execute the following command to apply <code>isort</code> and <code>black</code> formatting:</p>
<div class="highlight"><pre><span></span><code>make format
</code></pre></div>
<h2 id="license">License<a class="headerlink" href="#license" title="Permanent link">&para;</a></h2>
<p>This project is licensed under the terms of the MIT license.</p>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid">
<a href="installation/" title="Installation" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Installation
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
</div>
</a>
</nav>
</div>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
powered by
<a href="https://www.mkdocs.org" target="_blank" rel="noopener">
MkDocs
</a>
and
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<script src="assets/javascripts/bundle.bd6ef04a.min.js"></script><script id="__lang" type="application/json">
{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.language": "en", "search.pipeline.stopwords": "True", "search.pipeline.trimmer": "True", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.tokenizer": "[\\s\\-]+"}
</script>
<script>
app = initialize({
base: ".",
worker: {
search: "assets/javascripts/worker/search.926ffd9e.min.js"
},
feature: {
instant: false
}
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink