mirror of
				https://github.com/ycd/manage-fastapi.git
				synced 2021-11-08 01:34:39 +03:00 
			
		
		
		
	
		
			
				
	
	
		
			630 lines
		
	
	
		
			20 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			630 lines
		
	
	
		
			20 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
 | 
						||
<!doctype html>
 | 
						||
<html lang="en" class="no-js">
 | 
						||
  <head>
 | 
						||
    
 | 
						||
      <meta charset="utf-8">
 | 
						||
      <meta name="viewport" content="width=device-width,initial-scale=1">
 | 
						||
      
 | 
						||
      
 | 
						||
      
 | 
						||
      
 | 
						||
      <link rel="icon" href="assets/images/favicon.png">
 | 
						||
      <meta name="generator" content="mkdocs-1.2.2, mkdocs-material-7.2.6">
 | 
						||
    
 | 
						||
    
 | 
						||
      
 | 
						||
        <title>Manage FastAPI</title>
 | 
						||
      
 | 
						||
    
 | 
						||
    
 | 
						||
      <link rel="stylesheet" href="assets/stylesheets/main.802231af.min.css">
 | 
						||
      
 | 
						||
        
 | 
						||
        <link rel="stylesheet" href="assets/stylesheets/palette.3f5d1f46.min.css">
 | 
						||
        
 | 
						||
          
 | 
						||
          
 | 
						||
          <meta name="theme-color" content="#4cae4f">
 | 
						||
        
 | 
						||
      
 | 
						||
    
 | 
						||
    
 | 
						||
    
 | 
						||
      
 | 
						||
        
 | 
						||
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
 | 
						||
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Ubuntu:300,400,400i,700%7C&display=fallback">
 | 
						||
        <style>:root{--md-text-font-family:"Ubuntu";--md-code-font-family:""}</style>
 | 
						||
      
 | 
						||
    
 | 
						||
    
 | 
						||
    
 | 
						||
    
 | 
						||
      
 | 
						||
 | 
						||
 | 
						||
    
 | 
						||
    
 | 
						||
  </head>
 | 
						||
  
 | 
						||
  
 | 
						||
    
 | 
						||
    
 | 
						||
    
 | 
						||
    
 | 
						||
    
 | 
						||
    <body dir="ltr" data-md-color-scheme="" data-md-color-primary="green" data-md-color-accent="orange">
 | 
						||
  
 | 
						||
    
 | 
						||
    <script>function __prefix(e){return new URL(".",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
 | 
						||
    
 | 
						||
    <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>
 | 
						||
    <div data-md-component="skip">
 | 
						||
      
 | 
						||
        
 | 
						||
        <a href="#features" class="md-skip">
 | 
						||
          Skip to content
 | 
						||
        </a>
 | 
						||
      
 | 
						||
    </div>
 | 
						||
    <div data-md-component="announce">
 | 
						||
      
 | 
						||
    </div>
 | 
						||
    
 | 
						||
      <header class="md-header" data-md-component="header">
 | 
						||
  <nav class="md-header__inner md-grid" aria-label="Header">
 | 
						||
    <a href="." title="Manage FastAPI" class="md-header__button md-logo" aria-label="Manage FastAPI" data-md-component="logo">
 | 
						||
      
 | 
						||
  
 | 
						||
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 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 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
 | 
						||
 | 
						||
    </a>
 | 
						||
    <label class="md-header__button md-icon" for="__drawer">
 | 
						||
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></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">
 | 
						||
            Manage FastAPI
 | 
						||
          </span>
 | 
						||
        </div>
 | 
						||
        <div class="md-header__topic" data-md-component="header-topic">
 | 
						||
          <span class="md-ellipsis">
 | 
						||
            
 | 
						||
              Manage FastAPI
 | 
						||
            
 | 
						||
          </span>
 | 
						||
        </div>
 | 
						||
      </div>
 | 
						||
    </div>
 | 
						||
    
 | 
						||
    
 | 
						||
    
 | 
						||
      <label class="md-header__button md-icon" for="__search">
 | 
						||
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><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"/></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 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" required>
 | 
						||
      <label class="md-search__icon md-icon" for="__search">
 | 
						||
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><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"/></svg>
 | 
						||
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
 | 
						||
      </label>
 | 
						||
      <nav class="md-search__options" aria-label="Search">
 | 
						||
        
 | 
						||
        <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 | 
						||
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><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"/></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 href="https://github.com/ycd/manage-fastapi/" title="Go to repository" class="md-source" data-md-component="source">
 | 
						||
  <div class="md-source__icon md-icon">
 | 
						||
    
 | 
						||
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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"/></svg>
 | 
						||
  </div>
 | 
						||
  <div class="md-source__repository">
 | 
						||
    ycd/Manage-FastAPI
 | 
						||
  </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 class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 | 
						||
  <label class="md-nav__title" for="__drawer">
 | 
						||
    <a href="." title="Manage FastAPI" class="md-nav__button md-logo" aria-label="Manage FastAPI" data-md-component="logo">
 | 
						||
      
 | 
						||
  
 | 
						||
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 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 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
 | 
						||
 | 
						||
    </a>
 | 
						||
    Manage FastAPI
 | 
						||
  </label>
 | 
						||
  
 | 
						||
    <div class="md-nav__source">
 | 
						||
      
 | 
						||
<a href="https://github.com/ycd/manage-fastapi/" title="Go to repository" class="md-source" data-md-component="source">
 | 
						||
  <div class="md-source__icon md-icon">
 | 
						||
    
 | 
						||
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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"/></svg>
 | 
						||
  </div>
 | 
						||
  <div class="md-source__repository">
 | 
						||
    ycd/Manage-FastAPI
 | 
						||
  </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" type="checkbox" id="__toc">
 | 
						||
      
 | 
						||
      
 | 
						||
      
 | 
						||
        <label class="md-nav__link md-nav__link--active" for="__toc">
 | 
						||
          Manage FastAPI
 | 
						||
          <span class="md-nav__icon md-icon"></span>
 | 
						||
        </label>
 | 
						||
      
 | 
						||
      <a href="." class="md-nav__link md-nav__link--active">
 | 
						||
        Manage FastAPI
 | 
						||
      </a>
 | 
						||
      
 | 
						||
        
 | 
						||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 | 
						||
  
 | 
						||
  
 | 
						||
  
 | 
						||
  
 | 
						||
    <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 href="#features" class="md-nav__link">
 | 
						||
    Features 🚀
 | 
						||
  </a>
 | 
						||
  
 | 
						||
    <nav class="md-nav" aria-label="Features 🚀">
 | 
						||
      <ul class="md-nav__list">
 | 
						||
        
 | 
						||
          <li class="md-nav__item">
 | 
						||
  <a href="#creates-customizable-project-boilerplate" class="md-nav__link">
 | 
						||
    Creates customizable project boilerplate.
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</li>
 | 
						||
        
 | 
						||
          <li class="md-nav__item">
 | 
						||
  <a href="#creates-customizable-app-boilerplate" class="md-nav__link">
 | 
						||
    Creates customizable app boilerplate.
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</li>
 | 
						||
        
 | 
						||
          <li class="md-nav__item">
 | 
						||
  <a href="#handles-the-project-structuring-for-you" class="md-nav__link">
 | 
						||
    Handles the project structuring for you.
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</li>
 | 
						||
        
 | 
						||
      </ul>
 | 
						||
    </nav>
 | 
						||
  
 | 
						||
</li>
 | 
						||
      
 | 
						||
        <li class="md-nav__item">
 | 
						||
  <a href="#installation" class="md-nav__link">
 | 
						||
    Installation
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</li>
 | 
						||
      
 | 
						||
        <li class="md-nav__item">
 | 
						||
  <a href="#usage" class="md-nav__link">
 | 
						||
    Usage
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</li>
 | 
						||
      
 | 
						||
        <li class="md-nav__item">
 | 
						||
  <a href="#command-line-options" class="md-nav__link">
 | 
						||
    Command line options
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</li>
 | 
						||
      
 | 
						||
        <li class="md-nav__item">
 | 
						||
  <a href="#license" class="md-nav__link">
 | 
						||
    License
 | 
						||
  </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_2" type="checkbox" id="__nav_2" >
 | 
						||
      
 | 
						||
      <label class="md-nav__link" for="__nav_2">
 | 
						||
        Manage Projects
 | 
						||
        <span class="md-nav__icon md-icon"></span>
 | 
						||
      </label>
 | 
						||
      <nav class="md-nav" aria-label="Manage Projects" data-md-level="1">
 | 
						||
        <label class="md-nav__title" for="__nav_2">
 | 
						||
          <span class="md-nav__icon md-icon"></span>
 | 
						||
          Manage Projects
 | 
						||
        </label>
 | 
						||
        <ul class="md-nav__list" data-md-scrollfix>
 | 
						||
          
 | 
						||
            
 | 
						||
  
 | 
						||
  
 | 
						||
  
 | 
						||
    <li class="md-nav__item">
 | 
						||
      <a href="managing_projects/startproject.md" class="md-nav__link">
 | 
						||
        Start new project
 | 
						||
      </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" type="checkbox" id="__nav_3" >
 | 
						||
      
 | 
						||
      <label class="md-nav__link" for="__nav_3">
 | 
						||
        Manage Apps
 | 
						||
        <span class="md-nav__icon md-icon"></span>
 | 
						||
      </label>
 | 
						||
      <nav class="md-nav" aria-label="Manage Apps" data-md-level="1">
 | 
						||
        <label class="md-nav__title" for="__nav_3">
 | 
						||
          <span class="md-nav__icon md-icon"></span>
 | 
						||
          Manage Apps
 | 
						||
        </label>
 | 
						||
        <ul class="md-nav__list" data-md-scrollfix>
 | 
						||
          
 | 
						||
            
 | 
						||
  
 | 
						||
  
 | 
						||
  
 | 
						||
    <li class="md-nav__item">
 | 
						||
      <a href="managing_apps/startapp.md" class="md-nav__link">
 | 
						||
        Start new app
 | 
						||
      </a>
 | 
						||
    </li>
 | 
						||
  
 | 
						||
 | 
						||
          
 | 
						||
        </ul>
 | 
						||
      </nav>
 | 
						||
    </li>
 | 
						||
  
 | 
						||
 | 
						||
    
 | 
						||
      
 | 
						||
      
 | 
						||
      
 | 
						||
 | 
						||
  
 | 
						||
  
 | 
						||
  
 | 
						||
    <li class="md-nav__item">
 | 
						||
      <a href="release-notes/" class="md-nav__link">
 | 
						||
        Release Notes
 | 
						||
      </a>
 | 
						||
    </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 class="md-nav md-nav--secondary" aria-label="Table of contents">
 | 
						||
  
 | 
						||
  
 | 
						||
  
 | 
						||
  
 | 
						||
    <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 href="#features" class="md-nav__link">
 | 
						||
    Features 🚀
 | 
						||
  </a>
 | 
						||
  
 | 
						||
    <nav class="md-nav" aria-label="Features 🚀">
 | 
						||
      <ul class="md-nav__list">
 | 
						||
        
 | 
						||
          <li class="md-nav__item">
 | 
						||
  <a href="#creates-customizable-project-boilerplate" class="md-nav__link">
 | 
						||
    Creates customizable project boilerplate.
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</li>
 | 
						||
        
 | 
						||
          <li class="md-nav__item">
 | 
						||
  <a href="#creates-customizable-app-boilerplate" class="md-nav__link">
 | 
						||
    Creates customizable app boilerplate.
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</li>
 | 
						||
        
 | 
						||
          <li class="md-nav__item">
 | 
						||
  <a href="#handles-the-project-structuring-for-you" class="md-nav__link">
 | 
						||
    Handles the project structuring for you.
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</li>
 | 
						||
        
 | 
						||
      </ul>
 | 
						||
    </nav>
 | 
						||
  
 | 
						||
</li>
 | 
						||
      
 | 
						||
        <li class="md-nav__item">
 | 
						||
  <a href="#installation" class="md-nav__link">
 | 
						||
    Installation
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</li>
 | 
						||
      
 | 
						||
        <li class="md-nav__item">
 | 
						||
  <a href="#usage" class="md-nav__link">
 | 
						||
    Usage
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</li>
 | 
						||
      
 | 
						||
        <li class="md-nav__item">
 | 
						||
  <a href="#command-line-options" class="md-nav__link">
 | 
						||
    Command line options
 | 
						||
  </a>
 | 
						||
  
 | 
						||
</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" data-md-component="content">
 | 
						||
            <article class="md-content__inner md-typeset">
 | 
						||
              
 | 
						||
                
 | 
						||
                  <a href="https://github.com/ycd/manage-fastapi/edit/master/docs/index.md" title="Edit this page" class="md-content__button md-icon">
 | 
						||
                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
 | 
						||
                  </a>
 | 
						||
                
 | 
						||
                
 | 
						||
                  <h1>Manage FastAPI</h1>
 | 
						||
                
 | 
						||
                <h3 align="center">
 | 
						||
    <strong>Manage FastAPI projects easily</strong>
 | 
						||
</h3>
 | 
						||
<p align="center">
 | 
						||
    <a href="https://github.com/ycd/manage-fastapi" target="_blank">
 | 
						||
        <img src="https://img.shields.io/github/last-commit/ycd/manage-fastapi?style=for-the-badge" alt="Latest Commit">
 | 
						||
    </a>
 | 
						||
        <img src="https://img.shields.io/github/workflow/status/ycd/manage-fastapi/Test?style=for-the-badge">
 | 
						||
        <img src="https://img.shields.io/codecov/c/github/ycd/manage-fastapi?style=for-the-badge">
 | 
						||
    <br />
 | 
						||
    <a href="https://pypi.org/project/manage-fastapi" target="_blank">
 | 
						||
        <img src="https://img.shields.io/pypi/v/manage-fastapi?style=for-the-badge" alt="Package version">
 | 
						||
    </a>
 | 
						||
    <img src="https://img.shields.io/pypi/pyversions/manage-fastapi?style=for-the-badge">
 | 
						||
    <img src="https://img.shields.io/github/license/ycd/manage-fastapi?style=for-the-badge">
 | 
						||
</p>
 | 
						||
 | 
						||
<hr />
 | 
						||
<p><strong>Documentation</strong>: View it on <a href="https://ycd.github.io/manage-fastapi/">website</a></p>
 | 
						||
<p><strong>Source Code</strong>: View it on <a href="https://github.com/ycd/manage-fastapi/">Github</a></p>
 | 
						||
<hr />
 | 
						||
<h2 id="features">Features 🚀<a class="headerlink" href="#features" title="Permanent link">¶</a></h2>
 | 
						||
<ul>
 | 
						||
<li>
 | 
						||
<h4 id="creates-customizable-project-boilerplate">Creates customizable <strong>project boilerplate.</strong><a class="headerlink" href="#creates-customizable-project-boilerplate" title="Permanent link">¶</a></h4>
 | 
						||
</li>
 | 
						||
<li>
 | 
						||
<h4 id="creates-customizable-app-boilerplate">Creates customizable <strong>app boilerplate.</strong><a class="headerlink" href="#creates-customizable-app-boilerplate" title="Permanent link">¶</a></h4>
 | 
						||
</li>
 | 
						||
<li>
 | 
						||
<h4 id="handles-the-project-structuring-for-you">Handles the project structuring for you.<a class="headerlink" href="#handles-the-project-structuring-for-you" title="Permanent link">¶</a></h4>
 | 
						||
</li>
 | 
						||
</ul>
 | 
						||
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">¶</a></h2>
 | 
						||
<p>Manage FastAPI can be installed by running <code>pip install manage-fastapi</code>. It requires Python 3.6+ to run.</p>
 | 
						||
<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¶</a></h2>
 | 
						||
<p>To get started right away with sensible defaults:</p>
 | 
						||
<div class="codehilite"><pre><span></span><code>fastapi startproject <span class="o">{</span>name<span class="o">}</span>
 | 
						||
</code></pre></div>
 | 
						||
 | 
						||
<p>You can run <em>Manage FastAPI</em> as a package if running it as a script doesn’t work:</p>
 | 
						||
<div class="codehilite"><pre><span></span><code>python -m fastapi startproject <span class="o">{</span>name<span class="o">}</span>
 | 
						||
</code></pre></div>
 | 
						||
 | 
						||
<h2 id="command-line-options">Command line options<a class="headerlink" href="#command-line-options" title="Permanent link">¶</a></h2>
 | 
						||
<p>Manage FastAPI has three commands for now. You can list them by running <code>fastapi --help</code>:</p>
 | 
						||
<p><img src="../docs_assets/fastapi-help.png" width=700></p>
 | 
						||
<p>The idea is to have a highly customizable CLI, but at the same time a simple interface for new users. You can see the available options for <code>startproject</code> running <code>fastapi startproject --help</code>:</p>
 | 
						||
<p><img src="../docs_assets/startproject-help.png" width=700></p>
 | 
						||
<p>The other commands are already available but the current implementation is too shallow. More details about <code>startapp</code> and <code>run</code> commands will be provided once they have more functionalities, at the moment you can run <code>startapp</code> by just:</p>
 | 
						||
<div class="codehilite"><pre><span></span><code>fastapi startapp <span class="o">{</span>name<span class="o">}</span>
 | 
						||
</code></pre></div>
 | 
						||
 | 
						||
<p>On the other hand, the <code>run</code> command expects you to have a <code>startproject</code> structure:</p>
 | 
						||
<div class="codehilite"><pre><span></span><code>fastapi run
 | 
						||
</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 class="md-footer__inner md-grid" aria-label="Footer">
 | 
						||
      
 | 
						||
      
 | 
						||
        
 | 
						||
        <a href="release-notes/" class="md-footer__link md-footer__link--next" aria-label="Next: Release Notes" rel="next">
 | 
						||
          <div class="md-footer__title">
 | 
						||
            <div class="md-ellipsis">
 | 
						||
              <span class="md-footer__direction">
 | 
						||
                Next
 | 
						||
              </span>
 | 
						||
              Release Notes
 | 
						||
            </div>
 | 
						||
          </div>
 | 
						||
          <div class="md-footer__button md-icon">
 | 
						||
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
 | 
						||
          </div>
 | 
						||
        </a>
 | 
						||
      
 | 
						||
    </nav>
 | 
						||
  
 | 
						||
  <div class="md-footer-meta md-typeset">
 | 
						||
    <div class="md-footer-meta__inner md-grid">
 | 
						||
      <div class="md-footer-copyright">
 | 
						||
        
 | 
						||
        Made with
 | 
						||
        <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
 | 
						||
          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.409db549.min.js", "version": null}</script>
 | 
						||
    
 | 
						||
    
 | 
						||
      <script src="assets/javascripts/bundle.756773cc.min.js"></script>
 | 
						||
      
 | 
						||
    
 | 
						||
  </body>
 | 
						||
</html> |