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
db2cec28baa59f2eb071c3008f9f7a9ad06dc594
fastapi-users/index.html

784 lines
63 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8"/>
<meta content="width=device-width,initial-scale=1" name="viewport"/>
<meta content="Ready-to-use and customizable users management for FastAPI" name="description"/>
<link href="favicon.png" rel="icon"/>
<meta content="mkdocs-1.2.4, mkdocs-material-8.2.7" name="generator"/>
<title>FastAPI Users</title>
<link href="assets/stylesheets/main.9d5733d3.min.css" rel="stylesheet"/>
<link href="assets/stylesheets/palette.e6a45f82.min.css" rel="stylesheet"/>
<link crossorigin="" href="https://fonts.gstatic.com" rel="preconnect"/>
<link href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&amp;display=fallback" rel="stylesheet"/>
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL(".",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body data-md-color-accent="red" data-md-color-primary="red" data-md-color-scheme="default" dir="ltr">
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
<input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
<input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a class="md-skip" href="#fastapi-users">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav aria-label="Header" class="md-header__inner md-grid">
<a aria-label="FastAPI Users" class="md-header__button md-logo" data-md-component="logo" href="." title="FastAPI Users">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M16.5 12A2.5 2.5 0 0 0 19 9.5 2.5 2.5 0 0 0 16.5 7 2.5 2.5 0 0 0 14 9.5a2.5 2.5 0 0 0 2.5 2.5M9 11a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m7.5 3c-1.83 0-5.5.92-5.5 2.75V19h11v-2.25c0-1.83-3.67-2.75-5.5-2.75M9 13c-2.33 0-7 1.17-7 3.5V19h7v-2.25c0-.85.33-2.34 2.37-3.47C10.5 13.1 9.66 13 9 13z"></path></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"></path></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
FastAPI Users
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
About
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input aria-label="Switch to dark mode" class="md-option" data-md-color-accent="red" data-md-color-media="" data-md-color-primary="red" data-md-color-scheme="default" id="__palette_1" name="__palette" type="radio"/>
<label class="md-header__button md-icon" for="__palette_2" hidden="" title="Switch to dark mode">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1z"></path></svg>
</label>
<input aria-label="Switch to light mode" class="md-option" data-md-color-accent="red" data-md-color-media="" data-md-color-primary="red" data-md-color-scheme="slate" id="__palette_2" name="__palette" type="radio"/>
<label class="md-header__button md-icon" for="__palette_1" hidden="" title="Switch to light mode">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 2a7 7 0 0 1 7 7c0 2.38-1.19 4.47-3 5.74V17a1 1 0 0 1-1 1H9a1 1 0 0 1-1-1v-2.26C6.19 13.47 5 11.38 5 9a7 7 0 0 1 7-7M9 21v-1h6v1a1 1 0 0 1-1 1h-4a1 1 0 0 1-1-1m3-17a5 5 0 0 0-5 5c0 2.05 1.23 3.81 3 4.58V16h4v-2.42c1.77-.77 3-2.53 3-4.58a5 5 0 0 0-5-5z"></path></svg>
</label>
</form>
<label class="md-header__button md-icon" for="__search">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"></path></svg>
</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 aria-label="Search" autocapitalize="off" autocomplete="off" autocorrect="off" class="md-search__input" data-md-component="search-query" name="query" placeholder="Search" required="" spellcheck="false" type="text"/>
<label class="md-search__icon md-icon" for="__search">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"></path></svg>
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"></path></svg>
</label>
<nav aria-label="Search" class="md-search__options">
<button aria-label="Clear" class="md-search__icon md-icon" tabindex="-1" type="reset">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"></path></svg>
</button>
</nav>
</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">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a class="md-source" data-md-component="source" href="https://github.com/fastapi-users/fastapi-users" title="Go to repository">
<div class="md-source__icon md-icon">
<svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 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"></path></svg>
</div>
<div class="md-source__repository">
frankie567/fastapi-users
</div>
</a>
</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="sidebar" data-md-type="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav aria-label="Navigation" class="md-nav md-nav--primary" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a aria-label="FastAPI Users" class="md-nav__button md-logo" data-md-component="logo" href="." title="FastAPI Users">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M16.5 12A2.5 2.5 0 0 0 19 9.5 2.5 2.5 0 0 0 16.5 7 2.5 2.5 0 0 0 14 9.5a2.5 2.5 0 0 0 2.5 2.5M9 11a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m7.5 3c-1.83 0-5.5.92-5.5 2.75V19h11v-2.25c0-1.83-3.67-2.75-5.5-2.75M9 13c-2.33 0-7 1.17-7 3.5V19h7v-2.25c0-.85.33-2.34 2.37-3.47C10.5 13.1 9.66 13 9 13z"></path></svg>
</a>
FastAPI Users
</label>
<div class="md-nav__source">
<a class="md-source" data-md-component="source" href="https://github.com/fastapi-users/fastapi-users" title="Go to repository">
<div class="md-source__icon md-icon">
<svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 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"></path></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-nav__toggle md-toggle" data-md-toggle="toc" id="__toc" type="checkbox"/>
<label class="md-nav__link md-nav__link--active" for="__toc">
About
<span class="md-nav__icon md-icon"></span>
</label>
<a class="md-nav__link md-nav__link--active" href=".">
About
</a>
<nav aria-label="Table of contents" class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#features">
Features
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#in-a-hurry-discover-fief-the-open-source-authentication-platform">
In a hurry? Discover Fief, the open-source authentication platform
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#contributors-and-sponsors">
Contributors and sponsors ✨☕️
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#development">
Development
</a>
<nav aria-label="Development" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#setup-environment">
Setup environment
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#run-unit-tests">
Run unit tests
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#format-the-code">
Format the code
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#license">
License
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="installation/">
Installation
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" id="__nav_3" type="checkbox"/>
<label class="md-nav__link" for="__nav_3">
Configuration
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Configuration" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Configuration
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/overview/">
Overview
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/models/">
Models
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_3" id="__nav_3_3" type="checkbox"/>
<label class="md-nav__link" for="__nav_3_3">
Database adapters
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Database adapters" class="md-nav" data-md-level="2">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
Database adapters
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/databases/sqlalchemy/">
SQLAlchemy
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/databases/mongodb/">
MongoDB
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/databases/tortoise/">
Tortoise ORM
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/databases/ormar/">
Ormar
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4" id="__nav_3_4" type="checkbox"/>
<label class="md-nav__link" for="__nav_3_4">
Authentication backends
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Authentication backends" class="md-nav" data-md-level="2">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Authentication backends
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/authentication/">
Introduction
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4_2" id="__nav_3_4_2" type="checkbox"/>
<label class="md-nav__link" for="__nav_3_4_2">
Transports
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Transports" class="md-nav" data-md-level="3">
<label class="md-nav__title" for="__nav_3_4_2">
<span class="md-nav__icon md-icon"></span>
Transports
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/authentication/transports/cookie/">
Cookie
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/authentication/transports/bearer/">
Bearer
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4_3" id="__nav_3_4_3" type="checkbox"/>
<label class="md-nav__link" for="__nav_3_4_3">
Strategies
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Strategies" class="md-nav" data-md-level="3">
<label class="md-nav__title" for="__nav_3_4_3">
<span class="md-nav__icon md-icon"></span>
Strategies
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/authentication/strategies/database/">
Database
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/authentication/strategies/jwt/">
JWT
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/authentication/strategies/redis/">
Redis
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/authentication/backend/">
Create a backend
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/user-manager/">
UserManager
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_6" id="__nav_3_6" type="checkbox"/>
<label class="md-nav__link" for="__nav_3_6">
Routers
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Routers" class="md-nav" data-md-level="2">
<label class="md-nav__title" for="__nav_3_6">
<span class="md-nav__icon md-icon"></span>
Routers
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/routers/">
Introduction
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/routers/auth/">
Auth router
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/routers/register/">
Register routes
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/routers/verify/">
Verify router
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/routers/reset/">
Reset password router
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/routers/users/">
Users router
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/full-example/">
Full example
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/oauth/">
OAuth2
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="configuration/password-hash/">
Password hash
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" id="__nav_4" type="checkbox"/>
<label class="md-nav__link" for="__nav_4">
Usage
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Usage" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Usage
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="usage/flow/">
Flow
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="usage/routes/">
Routes
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="usage/current-user/">
Get current user
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" id="__nav_5" type="checkbox"/>
<label class="md-nav__link" for="__nav_5">
Cookbook
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Cookbook" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Cookbook
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="cookbook/create-user-programmatically/">
Create a user programmatically
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" id="__nav_6" type="checkbox"/>
<label class="md-nav__link" for="__nav_6">
Migration
<span class="md-nav__icon md-icon"></span>
</label>
<nav aria-label="Migration" class="md-nav" data-md-level="1">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Migration
</label>
<ul class="md-nav__list" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="migration/08_to_1x/">
0.8.x ➡️ 1.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="migration/1x_to_2x/">
1.x.x ➡️ 2.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="migration/2x_to_3x/">
2.x.x ➡️ 3.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="migration/3x_to_4x/">
3.x.x ➡️ 4.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="migration/4x_to_5x/">
4.x.x ➡️ 5.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="migration/6x_to_7x/">
6.x.x ➡️ 7.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="migration/7x_to_8x/">
7.x.x ➡️ 8.x.x
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="migration/8x_to_9x/">
8.x.x ➡️ 9.x.x
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav aria-label="Table of contents" class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#features">
Features
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#in-a-hurry-discover-fief-the-open-source-authentication-platform">
In a hurry? Discover Fief, the open-source authentication platform
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#contributors-and-sponsors">
Contributors and sponsors ✨☕️
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#development">
Development
</a>
<nav aria-label="Development" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#setup-environment">
Setup environment
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#run-unit-tests">
Run unit tests
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#format-the-code">
Format the code
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#license">
License
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="fastapi-users">FastAPI Users<a class="headerlink" href="#fastapi-users" title="Permanent link"></a></h1>
<p align="center">
<img alt="FastAPI Users" src="https://raw.githubusercontent.com/fastapi-users/fastapi-users/master/logo.svg?sanitize=true"/>
</p>
<p align="center">
<em>Ready-to-use and customizable users management for FastAPI </em>
</p>
<p><a href="https://github.com/fastapi-users/fastapi-users/actions"><img alt="build" src="https://github.com/fastapi-users/fastapi-users/workflows/Build/badge.svg"/></a>
<a href="https://codecov.io/gh/fastapi-users/fastapi-users"><img alt="codecov" src="https://codecov.io/gh/fastapi-users/fastapi-users/branch/master/graph/badge.svg"/></a>
<a href="https://badge.fury.io/py/fastapi-users"><img alt="PyPI version" src="https://badge.fury.io/py/fastapi-users.svg"/></a>
<a href="https://pepy.tech/project/fastapi-users"><img alt="Downloads" src="https://pepy.tech/badge/fastapi-users"/></a></p>
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<p><a href="#contributors-"><img alt="All Contributors" src="https://img.shields.io/badge/all_contributors-54-orange.svg?style=flat-square"/></a></p>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<p align="center">
<a href="https://www.buymeacoffee.com/frankie567"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&amp;emoji=&amp;slug=frankie567&amp;button_colour=FF5F5F&amp;font_colour=ffffff&amp;font_family=Arial&amp;outline_colour=000000&amp;coffee_colour=FFDD00"/></a>
</p>
<hr/>
<p><strong>Documentation</strong>: <a href="https://fastapi-users.github.io/fastapi-users/" target="_blank">https://fastapi-users.github.io/fastapi-users/</a></p>
<p><strong>Source Code</strong>: <a href="https://github.com/fastapi-users/fastapi-users" target="_blank">https://github.com/fastapi-users/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"></a></h2>
<ul class="task-list">
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> Extensible base user model</input></li>
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> Ready-to-use register, login, reset password and verify e-mail routes</input></li>
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> Ready-to-use social OAuth2 login flow</input></li>
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> Dependency callables to inject current user in route</input></li>
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> Pluggable password validation</input></li>
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> Customizable database backend<ul class="task-list">
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> <a href="https://docs.sqlalchemy.org/en/14/orm/extensions/asyncio.html">SQLAlchemy ORM async</a> backend included</input></li>
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> MongoDB async backend included thanks to <a href="https://github.com/mongodb/motor">mongodb/motor</a></input></li>
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> <a href="https://tortoise-orm.readthedocs.io/en/latest/">Tortoise ORM</a> backend included</input></li>
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> <a href="https://collerek.github.io/ormar/">ormar</a> backend included</input></li>
</ul>
</input></li>
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> Multiple customizable authentication backends<ul class="task-list">
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> Transports: Authorization header, Cookie</input></li>
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> Strategies: JWT, Database, Redis</input></li>
</ul>
</input></li>
<li class="task-list-item"><input checked="" disabled="" type="checkbox"> Full OpenAPI schema support, even with several authentication backends</input></li>
</ul>
<h2 id="in-a-hurry-discover-fief-the-open-source-authentication-platform">In a hurry? Discover Fief, the open-source authentication platform<a class="headerlink" href="#in-a-hurry-discover-fief-the-open-source-authentication-platform" title="Permanent link"></a></h2>
<p align="center">
<img alt="Fief" src="https://raw.githubusercontent.com/fief-dev/.github/main/logos/logo-full-red.svg?sanitize=true" width="256"/>
</p>
<p><img align="right" alt="Fief" height="300" src="https://www.fief.dev/illustrations/guard-right.svg"/></p>
<p><strong>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.</strong></p>
<ul>
<li>Based on <strong>FastAPI Users</strong>!</li>
<li><strong>Open-source</strong>: self-host it for free or use our hosted version</li>
<li><strong>Bring your own database</strong>: host your database anywhere, we'll take care of the rest</li>
<li><strong>Pre-built login and registration pages</strong>: clean and fast authentication so you don't have to do it yourself</li>
<li><strong>Official Python client</strong> with built-in <strong>FastAPI integration</strong></li>
<li>Integrate a simple face detection algorithm in a FastAPI backend</li>
<li>Integrate common Python data science libraries in a web backend</li>
<li>Deploy a performant and reliable web backend for a data science application</li>
</ul>
<p align="center">
<a href="https://www.fief.dev"><img src="data:image/svg+xml;base64,<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg width="100%" height="100%" viewBox="0 0 220 60" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
    <g transform="matrix(5.04408,0,0,2.47216,-61.9304,-17.8504)">
        <path d="M55.893,9.772C55.893,8.364 55.333,7.221 54.643,7.221L13.528,7.221C12.838,7.221 12.278,8.364 12.278,9.772L12.278,28.939C12.278,30.348 12.838,31.491 13.528,31.491L54.643,31.491C55.333,31.491 55.893,30.348 55.893,28.939L55.893,9.772Z" style="fill:rgb(244,63,94);"/>
    </g>
    <g transform="matrix(1,0,0,1,-14.0256,-7.69128)">
        <g transform="matrix(30,0,0,30,29.3754,48.6004)">
            <path d="M0.359,-0.727L0.489,-0.727L0.489,-0.216C0.489,-0.169 0.479,-0.129 0.46,-0.095C0.44,-0.061 0.412,-0.035 0.377,-0.017C0.342,0.001 0.301,0.01 0.255,0.01C0.212,0.01 0.174,0.002 0.14,-0.013C0.106,-0.028 0.079,-0.051 0.059,-0.081C0.039,-0.111 0.029,-0.148 0.029,-0.193L0.16,-0.193C0.16,-0.174 0.165,-0.157 0.173,-0.142C0.182,-0.128 0.193,-0.117 0.208,-0.11C0.223,-0.102 0.24,-0.098 0.26,-0.098C0.281,-0.098 0.299,-0.103 0.313,-0.112C0.328,-0.121 0.339,-0.134 0.347,-0.151C0.354,-0.169 0.358,-0.19 0.359,-0.216L0.359,-0.727Z" style="fill:white;fill-rule:nonzero;"/>
        </g>
        <g transform="matrix(30,0,0,30,46.1972,48.6004)">
            <path d="M0.304,0.011C0.251,0.011 0.205,-0.001 0.165,-0.025C0.126,-0.048 0.096,-0.081 0.075,-0.123C0.053,-0.165 0.043,-0.214 0.043,-0.271C0.043,-0.327 0.053,-0.376 0.075,-0.419C0.096,-0.461 0.126,-0.494 0.165,-0.517C0.205,-0.541 0.251,-0.553 0.304,-0.553C0.357,-0.553 0.403,-0.541 0.442,-0.517C0.482,-0.494 0.512,-0.461 0.533,-0.419C0.555,-0.376 0.565,-0.327 0.565,-0.271C0.565,-0.214 0.555,-0.165 0.533,-0.123C0.512,-0.081 0.482,-0.048 0.442,-0.025C0.403,-0.001 0.357,0.011 0.304,0.011ZM0.305,-0.092C0.334,-0.092 0.358,-0.1 0.377,-0.116C0.397,-0.132 0.411,-0.154 0.421,-0.181C0.43,-0.208 0.435,-0.238 0.435,-0.271C0.435,-0.304 0.43,-0.335 0.421,-0.362C0.411,-0.389 0.397,-0.41 0.377,-0.426C0.358,-0.443 0.334,-0.451 0.305,-0.451C0.275,-0.451 0.251,-0.443 0.231,-0.426C0.211,-0.41 0.197,-0.389 0.187,-0.362C0.178,-0.335 0.173,-0.304 0.173,-0.271C0.173,-0.238 0.178,-0.208 0.187,-0.181C0.197,-0.154 0.211,-0.132 0.231,-0.116C0.251,-0.1 0.275,-0.092 0.305,-0.092Z" style="fill:white;fill-rule:nonzero;"/>
        </g>
        <g transform="matrix(30,0,0,30,64.4358,48.6004)">
            <path d="M0.066,-0L0.066,-0.545L0.195,-0.545L0.195,-0L0.066,-0ZM0.131,-0.623C0.11,-0.623 0.093,-0.63 0.078,-0.643C0.063,-0.657 0.056,-0.673 0.056,-0.692C0.056,-0.712 0.063,-0.728 0.078,-0.742C0.093,-0.756 0.11,-0.762 0.131,-0.762C0.151,-0.762 0.169,-0.756 0.183,-0.742C0.198,-0.728 0.205,-0.712 0.205,-0.692C0.205,-0.673 0.198,-0.657 0.183,-0.643C0.169,-0.63 0.151,-0.623 0.131,-0.623Z" style="fill:white;fill-rule:nonzero;"/>
        </g>
        <g transform="matrix(30,0,0,30,72.2554,48.6004)">
            <path d="M0.195,-0.32L0.195,-0L0.066,-0L0.066,-0.545L0.189,-0.545L0.189,-0.453L0.195,-0.453C0.208,-0.483 0.228,-0.508 0.256,-0.526C0.283,-0.544 0.317,-0.553 0.358,-0.553C0.396,-0.553 0.428,-0.545 0.456,-0.528C0.485,-0.512 0.506,-0.489 0.522,-0.458C0.537,-0.428 0.545,-0.391 0.545,-0.347L0.545,-0L0.416,-0L0.416,-0.327C0.416,-0.364 0.407,-0.392 0.388,-0.413C0.369,-0.434 0.343,-0.444 0.31,-0.444C0.288,-0.444 0.268,-0.439 0.25,-0.429C0.233,-0.419 0.219,-0.405 0.209,-0.387C0.2,-0.368 0.195,-0.346 0.195,-0.32Z" style="fill:white;fill-rule:nonzero;"/>
        </g>
        <g transform="matrix(30,0,0,30,97.994,48.6004)">
            <path d="M0.338,-0.545L0.338,-0.446L0.025,-0.446L0.025,-0.545L0.338,-0.545ZM0.102,-0.676L0.231,-0.676L0.231,-0.164C0.231,-0.147 0.233,-0.134 0.239,-0.124C0.244,-0.115 0.251,-0.109 0.26,-0.106C0.269,-0.103 0.278,-0.101 0.289,-0.101C0.297,-0.101 0.305,-0.101 0.311,-0.103C0.318,-0.104 0.323,-0.105 0.327,-0.106L0.348,-0.005C0.342,-0.003 0.332,-0 0.319,0.002C0.306,0.005 0.291,0.007 0.273,0.007C0.241,0.008 0.212,0.003 0.186,-0.007C0.16,-0.018 0.14,-0.035 0.124,-0.058C0.109,-0.08 0.102,-0.109 0.102,-0.143L0.102,-0.676Z" style="fill:white;fill-rule:nonzero;"/>
        </g>
        <g transform="matrix(30,0,0,30,109.734,48.6004)">
            <path d="M0.195,-0.32L0.195,-0L0.066,-0L0.066,-0.727L0.192,-0.727L0.192,-0.453L0.198,-0.453C0.211,-0.484 0.231,-0.508 0.258,-0.526C0.285,-0.544 0.319,-0.553 0.36,-0.553C0.398,-0.553 0.431,-0.545 0.46,-0.529C0.488,-0.513 0.51,-0.49 0.525,-0.459C0.541,-0.429 0.548,-0.391 0.548,-0.347L0.548,-0L0.42,-0L0.42,-0.327C0.42,-0.364 0.41,-0.393 0.392,-0.413C0.373,-0.434 0.346,-0.444 0.313,-0.444C0.29,-0.444 0.269,-0.439 0.252,-0.429C0.234,-0.419 0.22,-0.405 0.21,-0.387C0.2,-0.368 0.195,-0.346 0.195,-0.32Z" style="fill:white;fill-rule:nonzero;"/>
        </g>
        <g transform="matrix(30,0,0,30,128.122,48.6004)">
            <path d="M0.308,0.011C0.253,0.011 0.206,-0.001 0.166,-0.024C0.126,-0.046 0.096,-0.079 0.075,-0.121C0.053,-0.163 0.043,-0.212 0.043,-0.27C0.043,-0.326 0.053,-0.375 0.075,-0.417C0.096,-0.46 0.126,-0.493 0.165,-0.517C0.203,-0.541 0.249,-0.553 0.301,-0.553C0.334,-0.553 0.366,-0.547 0.396,-0.536C0.426,-0.526 0.453,-0.509 0.476,-0.487C0.499,-0.464 0.517,-0.435 0.53,-0.401C0.543,-0.366 0.55,-0.325 0.55,-0.277L0.55,-0.238L0.103,-0.238L0.103,-0.324L0.427,-0.324C0.427,-0.349 0.421,-0.371 0.411,-0.39C0.4,-0.409 0.386,-0.425 0.367,-0.436C0.349,-0.447 0.327,-0.452 0.303,-0.452C0.276,-0.452 0.253,-0.446 0.233,-0.433C0.213,-0.421 0.198,-0.404 0.187,-0.384C0.176,-0.363 0.17,-0.341 0.17,-0.316L0.17,-0.241C0.17,-0.209 0.176,-0.182 0.188,-0.159C0.199,-0.137 0.215,-0.119 0.236,-0.107C0.257,-0.095 0.281,-0.089 0.309,-0.089C0.328,-0.089 0.345,-0.092 0.36,-0.097C0.375,-0.103 0.388,-0.111 0.4,-0.121C0.411,-0.132 0.419,-0.144 0.425,-0.16L0.545,-0.146C0.537,-0.115 0.523,-0.087 0.502,-0.063C0.48,-0.04 0.453,-0.022 0.42,-0.009C0.388,0.004 0.35,0.011 0.308,0.011Z" style="fill:white;fill-rule:nonzero;"/>
        </g>
        <g transform="matrix(30,0,0,30,153.349,48.6004)">
            <path d="M0.072,-0L0.072,-0.727L0.2,-0.727L0.2,-0.455L0.206,-0.455C0.212,-0.469 0.222,-0.483 0.234,-0.498C0.246,-0.513 0.262,-0.526 0.283,-0.536C0.303,-0.547 0.33,-0.553 0.362,-0.553C0.404,-0.553 0.442,-0.542 0.476,-0.52C0.51,-0.499 0.537,-0.467 0.557,-0.426C0.577,-0.384 0.587,-0.333 0.587,-0.272C0.587,-0.212 0.577,-0.161 0.557,-0.119C0.538,-0.077 0.511,-0.045 0.477,-0.023C0.443,-0.001 0.405,0.01 0.362,0.01C0.331,0.01 0.305,0.004 0.284,-0.006C0.263,-0.016 0.247,-0.029 0.235,-0.044C0.222,-0.059 0.212,-0.073 0.206,-0.086L0.198,-0.086L0.198,-0L0.072,-0ZM0.198,-0.273C0.198,-0.237 0.203,-0.207 0.213,-0.18C0.223,-0.154 0.238,-0.133 0.257,-0.118C0.276,-0.103 0.299,-0.096 0.326,-0.096C0.354,-0.096 0.378,-0.104 0.397,-0.119C0.417,-0.134 0.431,-0.155 0.441,-0.182C0.451,-0.208 0.456,-0.239 0.456,-0.273C0.456,-0.307 0.451,-0.337 0.441,-0.363C0.431,-0.389 0.417,-0.41 0.398,-0.425C0.379,-0.44 0.355,-0.447 0.326,-0.447C0.299,-0.447 0.275,-0.44 0.256,-0.425C0.237,-0.411 0.222,-0.391 0.213,-0.365C0.203,-0.339 0.198,-0.308 0.198,-0.273Z" style="fill:white;fill-rule:nonzero;"/>
        </g>
        <g transform="matrix(30,0,0,30,172.259,48.6004)">
            <path d="M0.308,0.011C0.253,0.011 0.206,-0.001 0.166,-0.024C0.126,-0.046 0.096,-0.079 0.075,-0.121C0.053,-0.163 0.043,-0.212 0.043,-0.27C0.043,-0.326 0.053,-0.375 0.075,-0.417C0.096,-0.46 0.126,-0.493 0.165,-0.517C0.203,-0.541 0.249,-0.553 0.301,-0.553C0.334,-0.553 0.366,-0.547 0.396,-0.536C0.426,-0.526 0.453,-0.509 0.476,-0.487C0.499,-0.464 0.517,-0.435 0.53,-0.401C0.543,-0.366 0.55,-0.325 0.55,-0.277L0.55,-0.238L0.103,-0.238L0.103,-0.324L0.427,-0.324C0.427,-0.349 0.421,-0.371 0.411,-0.39C0.4,-0.409 0.386,-0.425 0.367,-0.436C0.349,-0.447 0.327,-0.452 0.303,-0.452C0.276,-0.452 0.253,-0.446 0.233,-0.433C0.213,-0.421 0.198,-0.404 0.187,-0.384C0.176,-0.363 0.17,-0.341 0.17,-0.316L0.17,-0.241C0.17,-0.209 0.176,-0.182 0.188,-0.159C0.199,-0.137 0.215,-0.119 0.236,-0.107C0.257,-0.095 0.281,-0.089 0.309,-0.089C0.328,-0.089 0.345,-0.092 0.36,-0.097C0.375,-0.103 0.388,-0.111 0.4,-0.121C0.411,-0.132 0.419,-0.144 0.425,-0.16L0.545,-0.146C0.537,-0.115 0.523,-0.087 0.502,-0.063C0.48,-0.04 0.453,-0.022 0.42,-0.009C0.388,0.004 0.35,0.011 0.308,0.011Z" style="fill:white;fill-rule:nonzero;"/>
        </g>
        <g transform="matrix(30,0,0,30,190.039,48.6004)">
            <path d="M0.338,-0.545L0.338,-0.446L0.025,-0.446L0.025,-0.545L0.338,-0.545ZM0.102,-0.676L0.231,-0.676L0.231,-0.164C0.231,-0.147 0.233,-0.134 0.239,-0.124C0.244,-0.115 0.251,-0.109 0.26,-0.106C0.269,-0.103 0.278,-0.101 0.289,-0.101C0.297,-0.101 0.305,-0.101 0.311,-0.103C0.318,-0.104 0.323,-0.105 0.327,-0.106L0.348,-0.005C0.342,-0.003 0.332,-0 0.319,0.002C0.306,0.005 0.291,0.007 0.273,0.007C0.241,0.008 0.212,0.003 0.186,-0.007C0.16,-0.018 0.14,-0.035 0.124,-0.058C0.109,-0.08 0.102,-0.109 0.102,-0.143L0.102,-0.676Z" style="fill:white;fill-rule:nonzero;"/>
        </g>
        <g transform="matrix(30,0,0,30,201.439,48.6004)">
            <path d="M0.223,0.011C0.188,0.011 0.157,0.005 0.13,-0.008C0.102,-0.02 0.08,-0.038 0.064,-0.063C0.048,-0.087 0.04,-0.117 0.04,-0.153C0.04,-0.184 0.046,-0.209 0.058,-0.229C0.069,-0.25 0.084,-0.266 0.104,-0.278C0.124,-0.29 0.146,-0.299 0.171,-0.305C0.195,-0.311 0.221,-0.316 0.248,-0.319C0.279,-0.322 0.305,-0.325 0.325,-0.328C0.345,-0.331 0.36,-0.335 0.369,-0.341C0.378,-0.347 0.382,-0.356 0.382,-0.368L0.382,-0.37C0.382,-0.397 0.375,-0.417 0.359,-0.432C0.343,-0.447 0.32,-0.454 0.29,-0.454C0.259,-0.454 0.234,-0.447 0.215,-0.434C0.197,-0.42 0.185,-0.404 0.178,-0.385L0.058,-0.402C0.068,-0.435 0.083,-0.463 0.105,-0.485C0.127,-0.508 0.154,-0.524 0.185,-0.536C0.217,-0.547 0.251,-0.553 0.289,-0.553C0.316,-0.553 0.342,-0.549 0.368,-0.543C0.394,-0.537 0.418,-0.527 0.439,-0.513C0.461,-0.499 0.478,-0.48 0.491,-0.456C0.504,-0.431 0.511,-0.401 0.511,-0.365L0.511,-0L0.387,-0L0.387,-0.075L0.383,-0.075C0.375,-0.06 0.364,-0.046 0.35,-0.032C0.336,-0.019 0.319,-0.009 0.297,-0.001C0.276,0.007 0.251,0.011 0.223,0.011ZM0.256,-0.083C0.282,-0.083 0.305,-0.089 0.324,-0.099C0.342,-0.109 0.357,-0.123 0.367,-0.14C0.378,-0.157 0.383,-0.176 0.383,-0.196L0.383,-0.26C0.379,-0.257 0.372,-0.254 0.362,-0.251C0.353,-0.248 0.342,-0.245 0.33,-0.243C0.318,-0.241 0.307,-0.239 0.295,-0.238C0.283,-0.236 0.273,-0.234 0.265,-0.233C0.246,-0.231 0.229,-0.226 0.213,-0.221C0.198,-0.215 0.186,-0.206 0.178,-0.196C0.169,-0.185 0.164,-0.172 0.164,-0.155C0.164,-0.132 0.173,-0.114 0.19,-0.102C0.208,-0.089 0.23,-0.083 0.256,-0.083Z" style="fill:white;fill-rule:nonzero;"/>
        </g>
    </g>
</svg>
" width="150px"/></a>
</p>
<p align="center">It's free!</p>
<h2 id="contributors-and-sponsors">Contributors and sponsors ✨☕️<a class="headerlink" href="#contributors-and-sponsors" title="Permanent link"></a></h2>
<p>Thanks goes to these wonderful people (<a href="https://allcontributors.org/docs/en/emoji-key">emoji key</a>):</p>
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="http://francoisvoron.com"><img alt="" src="https://avatars.githubusercontent.com/u/1144727?v=4?s=100" width="100px;"><br/><sub><b>François Voron</b></sub></img></a><br/><a href="#maintenance-frankie567" title="Maintenance">🚧</a></td>
<td align="center"><a href="https://github.com/paolodina"><img alt="" src="https://avatars.githubusercontent.com/u/1157401?v=4?s=100" width="100px;"><br/><sub><b>Paolo Dina</b></sub></img></a><br/><a href="#financial-paolodina" title="Financial">💵</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=paolodina" title="Code">💻</a></td>
<td align="center"><a href="https://freelancehunt.com/freelancer/slado122.html"><img alt="" src="https://avatars.githubusercontent.com/u/46085159?v=4?s=100" width="100px;"/><br/><sub><b>Dmytro Ohorodnik</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Aslado122" title="Bug reports">🐛</a></td>
<td align="center"><a href="http://matthewscholefield.github.io"><img alt="" src="https://avatars.githubusercontent.com/u/5875019?v=4?s=100" width="100px;"/><br/><sub><b>Matthew D. Scholefield</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3AMatthewScholefield" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/roywes"><img alt="" src="https://avatars.githubusercontent.com/u/3861579?v=4?s=100" width="100px;"/><br/><sub><b>roywes</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Aroywes" title="Bug reports">🐛</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=roywes" title="Code">💻</a></td>
<td align="center"><a href="https://devwriters.com"><img alt="" src="https://avatars.githubusercontent.com/u/10217535?v=4?s=100" width="100px;"/><br/><sub><b>Satwik Kansal</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=satwikkansal" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/eddsalkield"><img alt="" src="https://avatars.githubusercontent.com/u/30939717?v=4?s=100" width="100px;"/><br/><sub><b>Edd Salkield</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=eddsalkield" title="Code">💻</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=eddsalkield" title="Documentation">📖</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/mark-todd"><img alt="" src="https://avatars.githubusercontent.com/u/60781787?v=4?s=100" width="100px;"/><br/><sub><b>mark-todd</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=mark-todd" title="Code">💻</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=mark-todd" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/lill74"><img alt="" src="https://avatars.githubusercontent.com/u/12353597?v=4?s=100" width="100px;"/><br/><sub><b>lill74</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Alill74" title="Bug reports">🐛</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=lill74" title="Code">💻</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=lill74" title="Documentation">📖</a></td>
<td align="center"><a href="https://yacht.sh"><img alt="" src="https://avatars.githubusercontent.com/u/66331933?v=4?s=100" width="100px;"/><br/><sub><b>SelfhostedPro</b></sub></a><br/><a href="#security-SelfhostedPro" title="Security">🛡️</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=SelfhostedPro" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/oskar-gmerek"><img alt="" src="https://avatars.githubusercontent.com/u/53402105?v=4?s=100" width="100px;"/><br/><sub><b>Oskar Gmerek</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=oskar-gmerek" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/mcolladoio"><img alt="" src="https://avatars.githubusercontent.com/u/61695048?v=4?s=100" width="100px;"/><br/><sub><b>Martin Collado</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Amcolladoio" title="Bug reports">🐛</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=mcolladoio" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/nullhack"><img alt="" src="https://avatars.githubusercontent.com/u/11466701?v=4?s=100" width="100px;"/><br/><sub><b>Eric Lopes</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=nullhack" title="Documentation">📖</a> <a href="#security-nullhack" title="Security">🛡️</a></td>
<td align="center"><a href="https://github.com/rnd42"><img alt="" src="https://avatars.githubusercontent.com/u/618839?v=4?s=100" width="100px;"/><br/><sub><b>Beau Breon</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=rnd42" title="Code">💻</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/niazangels"><img alt="" src="https://avatars.githubusercontent.com/u/2761491?v=4?s=100" width="100px;"/><br/><sub><b>Niyas Mohammed</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=niazangels" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/prostomarkeloff"><img alt="" src="https://avatars.githubusercontent.com/u/28061158?v=4?s=100" width="100px;"/><br/><sub><b>prostomarkeloff</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=prostomarkeloff" title="Documentation">📖</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=prostomarkeloff" title="Code">💻</a></td>
<td align="center"><a href="https://www.linkedin.com/in/mariusmezerette/"><img alt="" src="https://avatars.githubusercontent.com/u/952685?v=4?s=100" width="100px;"/><br/><sub><b>Marius Mézerette</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3AMariusMez" title="Bug reports">🐛</a> <a href="#ideas-MariusMez" title="Ideas, Planning, &amp; Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/grigi"><img alt="" src="https://avatars.githubusercontent.com/u/1309160?v=4?s=100" width="100px;"/><br/><sub><b>Nickolas Grigoriadis</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Agrigi" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://opendatacoder.me"><img alt="" src="https://avatars.githubusercontent.com/u/7386680?v=4?s=100" width="100px;"/><br/><sub><b>Open Data Coder</b></sub></a><br/><a href="#ideas-p3t3r67x0" title="Ideas, Planning, &amp; Feedback">🤔</a></td>
<td align="center"><a href="https://www.dralshehri.com/"><img alt="" src="https://avatars.githubusercontent.com/u/542855?v=4?s=100" width="100px;"/><br/><sub><b>Mohammed Alshehri</b></sub></a><br/><a href="#ideas-dralshehri" title="Ideas, Planning, &amp; Feedback">🤔</a></td>
<td align="center"><a href="https://www.linkedin.com/in/lefnire/"><img alt="" src="https://avatars.githubusercontent.com/u/195202?v=4?s=100" width="100px;"/><br/><sub><b>Tyler Renelle</b></sub></a><br/><a href="#ideas-lefnire" title="Ideas, Planning, &amp; Feedback">🤔</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/collerek"><img alt="" src="https://avatars.githubusercontent.com/u/16324238?v=4?s=100" width="100px;"/><br/><sub><b>collerek</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=collerek" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/rbracco"><img alt="" src="https://avatars.githubusercontent.com/u/47190785?v=4?s=100" width="100px;"/><br/><sub><b>Robert Bracco</b></sub></a><br/><a href="#financial-rbracco" title="Financial">💵</a></td>
<td align="center"><a href="https://herrmann.tech"><img alt="" src="https://avatars.githubusercontent.com/u/1058414?v=4?s=100" width="100px;"/><br/><sub><b>Augusto Herrmann</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=augusto-herrmann" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/Smithybrewer"><img alt="" src="https://avatars.githubusercontent.com/u/57669591?v=4?s=100" width="100px;"/><br/><sub><b>Smithybrewer</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3ASmithybrewer" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/silllli"><img alt="" src="https://avatars.githubusercontent.com/u/9334305?v=4?s=100" width="100px;"/><br/><sub><b>silllli</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=silllli" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/alexferrari88"><img alt="" src="https://avatars.githubusercontent.com/u/49028826?v=4?s=100" width="100px;"/><br/><sub><b>alexferrari88</b></sub></a><br/><a href="#financial-alexferrari88" title="Financial">💵</a></td>
<td align="center"><a href="https://github.com/sandalwoodbox"><img alt="" src="https://avatars.githubusercontent.com/u/80227316?v=4?s=100" width="100px;"/><br/><sub><b>sandalwoodbox</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Asandalwoodbox" title="Bug reports">🐛</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/vladhoi"><img alt="" src="https://avatars.githubusercontent.com/u/33840957?v=4?s=100" width="100px;"/><br/><sub><b>Vlad Hoi</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=vladhoi" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/jnu"><img alt="" src="https://avatars.githubusercontent.com/u/1069899?v=4?s=100" width="100px;"/><br/><sub><b>Joe Nudell</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Ajnu" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/cosmosquark"><img alt="" src="https://avatars.githubusercontent.com/u/1540682?v=4?s=100" width="100px;"/><br/><sub><b>Ben</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=cosmosquark" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/BoYanZh"><img alt="" src="https://avatars.githubusercontent.com/u/32470225?v=4?s=100" width="100px;"/><br/><sub><b>BoYanZh</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=BoYanZh" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/davidbrochart"><img alt="" src="https://avatars.githubusercontent.com/u/4711805?v=4?s=100" width="100px;"/><br/><sub><b>David Brochart</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=davidbrochart" title="Documentation">📖</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=davidbrochart" title="Code">💻</a></td>
<td align="center"><a href="https://www.daanbeverdam.com"><img alt="" src="https://avatars.githubusercontent.com/u/13944585?v=4?s=100" width="100px;"/><br/><sub><b>Daan Beverdam</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=daanbeverdam" title="Code">💻</a></td>
<td align="center"><a href="http://sralab.com"><img alt="" src="https://avatars.githubusercontent.com/u/1815?v=4?s=100" width="100px;"/><br/><sub><b>Stéphane Raimbault</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=stephane" title="Tests">⚠️</a> <a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Astephane" title="Bug reports">🐛</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/sondrelg"><img alt="" src="https://avatars.githubusercontent.com/u/25310870?v=4?s=100" width="100px;"/><br/><sub><b>Sondre Lillebø Gundersen</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=sondrelg" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/maximka1221"><img alt="" src="https://avatars.githubusercontent.com/u/1503245?v=4?s=100" width="100px;"/><br/><sub><b>Maxim</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=maximka1221" title="Documentation">📖</a> <a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Amaximka1221" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/scottdavort"><img alt="" src="https://avatars.githubusercontent.com/u/58272461?v=4?s=100" width="100px;"/><br/><sub><b>scottdavort</b></sub></a><br/><a href="#financial-scottdavort" title="Financial">💵</a></td>
<td align="center"><a href="https://github.com/jdukewich"><img alt="" src="https://avatars.githubusercontent.com/u/37190801?v=4?s=100" width="100px;"/><br/><sub><b>John Dukewich</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=jdukewich" title="Documentation">📖</a></td>
<td align="center"><a href="http://yezz.me"><img alt="" src="https://avatars.githubusercontent.com/u/52716203?v=4?s=100" width="100px;"/><br/><sub><b>Yasser Tahiri</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=yezz123" title="Code">💻</a></td>
<td align="center"><a href="https://www.brandongoding.tech"><img alt="" src="https://avatars.githubusercontent.com/u/17888319?v=4?s=100" width="100px;"/><br/><sub><b>Brandon H. Goding</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=BrandonGoding" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/PovilasKud"><img alt="" src="https://avatars.githubusercontent.com/u/7852173?v=4?s=100" width="100px;"/><br/><sub><b>PovilasK</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=PovilasKud" title="Code">💻</a></td>
</tr>
<tr>
<td align="center"><a href="http://justobjects.nl"><img alt="" src="https://avatars.githubusercontent.com/u/582630?v=4?s=100" width="100px;"/><br/><sub><b>Just van den Broecke</b></sub></a><br/><a href="#financial-justb4" title="Financial">💵</a></td>
<td align="center"><a href="https://github.com/jakemanger"><img alt="" src="https://avatars.githubusercontent.com/u/52495554?v=4?s=100" width="100px;"/><br/><sub><b>jakemanger</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Ajakemanger" title="Bug reports">🐛</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=jakemanger" title="Code">💻</a></td>
<td align="center"><a href="https://bandism.net/"><img alt="" src="https://avatars.githubusercontent.com/u/22633385?v=4?s=100" width="100px;"/><br/><sub><b>Ikko Ashimine</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=eltociear" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/matyasrichter"><img alt="" src="https://avatars.githubusercontent.com/u/20258539?v=4?s=100" width="100px;"/><br/><sub><b>Matyáš Richter</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=matyasrichter" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/Hazedd"><img alt="" src="https://avatars.githubusercontent.com/u/20663495?v=4?s=100" width="100px;"/><br/><sub><b>Hazedd</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3AHazedd" title="Bug reports">🐛</a> <a href="https://github.com/fastapi-users/fastapi-users/commits?author=Hazedd" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/luisroel91"><img alt="" src="https://avatars.githubusercontent.com/u/44761184?v=4?s=100" width="100px;"/><br/><sub><b>Luis Roel</b></sub></a><br/><a href="#financial-luisroel91" title="Financial">💵</a></td>
<td align="center"><a href="https://ae-mc.ru"><img alt="" src="https://avatars.githubusercontent.com/u/43097289?v=4?s=100" width="100px;"/><br/><sub><b>Alexandr Makurin</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=Ae-Mc" title="Code">💻</a> <a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3AAe-Mc" title="Bug reports">🐛</a></td>
</tr>
<tr>
<td align="center"><a href="http://www.retoflow.de"><img alt="" src="https://avatars.githubusercontent.com/u/23637821?v=4?s=100" width="100px;"/><br/><sub><b>Leon Thurner</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=lthurner" title="Documentation">📖</a></td>
<td align="center"><a href="http://meka.rs"><img alt="" src="https://avatars.githubusercontent.com/u/610855?v=4?s=100" width="100px;"/><br/><sub><b>Goran Mekić</b></sub></a><br/><a href="#platform-mekanix" title="Packaging/porting to new platform">📦</a></td>
<td align="center"><a href="https://gaganpreet.in/"><img alt="" src="https://avatars.githubusercontent.com/u/815873?v=4?s=100" width="100px;"/><br/><sub><b>Gaganpreet</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=gaganpreet" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/jtv8"><img alt="" src="https://avatars.githubusercontent.com/u/29302451?v=4?s=100" width="100px;"/><br/><sub><b>Joe Taylor</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/commits?author=jtv8" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/ricfri"><img alt="" src="https://avatars.githubusercontent.com/u/21967765?v=4?s=100" width="100px;"/><br/><sub><b>Richard Friberg</b></sub></a><br/><a href="https://github.com/fastapi-users/fastapi-users/issues?q=author%3Aricfri" title="Bug reports">🐛</a></td>
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
<p>This project follows the <a href="https://github.com/all-contributors/all-contributors">all-contributors</a> specification. Contributions of any kind welcome!</p>
<h2 id="development">Development<a class="headerlink" href="#development" title="Permanent link"></a></h2>
<h3 id="setup-environment">Setup environment<a class="headerlink" href="#setup-environment" title="Permanent link"></a></h3>
<p>You should create a virtual environment and activate it:</p>
<div class="highlight"><pre><span></span><code>python -m venv venv/
</code></pre></div>
<div class="highlight"><pre><span></span><code><span class="nb">source</span> venv/bin/activate
</code></pre></div>
<p>And then install the development dependencies:</p>
<div class="highlight"><pre><span></span><code>make install
</code></pre></div>
<h3 id="run-unit-tests">Run unit tests<a class="headerlink" href="#run-unit-tests" title="Permanent link"></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>Alternatively, you can run <code>pytest</code> yourself.</p>
<div class="highlight"><pre><span></span><code>pytest
</code></pre></div>
<p>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:</p>
<div class="highlight"><pre><span></span><code><span class="nb">ulimit</span> -n <span class="m">2048</span>
</code></pre></div>
<h3 id="format-the-code">Format the code<a class="headerlink" href="#format-the-code" title="Permanent link"></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"></a></h2>
<p>This project is licensed under the terms of the MIT license.</p>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<nav aria-label="Footer" class="md-footer__inner md-grid">
<a aria-label="Next: Installation" class="md-footer__link md-footer__link--next" href="installation/" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Installation
</div>
</div>
<div class="md-footer__button md-icon">
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"></path></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" rel="noopener" target="_blank">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": ".", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "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.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.5e67fbfe.min.js"}</script>
<script src="assets/javascripts/bundle.e87a5f81.min.js"></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink