Metadata-Version: 2.1
Name: fastapi
Version: 0.61.2
Summary: FastAPI framework, high performance, easy to learn, fast to code, ready for production
Home-page: UNKNOWN
Author: Sebastián Ramírez
Author-email: tiangolo@gmail.com
License: UNKNOWN
Project-URL: Documentation, https://fastapi.tiangolo.com/
Project-URL: homepage, https://github.com/tiangolo/fastapi
Description: .. role:: raw-html-m2r(raw)
           :format: html
        
        
        
        .. raw:: html
        
           <p align="center">
             <a href="https://fastapi.tiangolo.com"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" alt="FastAPI"></a>
           </p>
           <p align="center">
               <em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em>
           </p>
           <p align="center">
           <a href="https://github.com/tiangolo/fastapi/actions?query=workflow%3ATest" target="_blank">
               <img src="https://github.com/tiangolo/fastapi/workflows/Test/badge.svg" alt="Test">
           </a>
           <a href="https://codecov.io/gh/tiangolo/fastapi" target="_blank">
               <img src="https://img.shields.io/codecov/c/github/tiangolo/fastapi?color=%2334D058" alt="Coverage">
           </a>
           <a href="https://pypi.org/project/fastapi" target="_blank">
               <img src="https://img.shields.io/pypi/v/fastapi?color=%2334D058&label=pypi%20package" alt="Package version">
           </a>
           <a href="https://gitter.im/tiangolo/fastapi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge" target="_blank">
               <img src="https://badges.gitter.im/tiangolo/fastapi.svg" alt="Join the chat at https://gitter.im/tiangolo/fastapi">
           </a>
           </p>
        
        
        ----
        
        **Documentation**\ : :raw-html-m2r:`<a href="https://fastapi.tiangolo.com" target="_blank">https://fastapi.tiangolo.com</a>`
        
        **Source Code**\ : :raw-html-m2r:`<a href="https://github.com/tiangolo/fastapi" target="_blank">https://github.com/tiangolo/fastapi</a>`
        
        ----
        
        FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
        
        The key features are:
        
        
        * 
          **Fast**\ : Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). `One of the fastest Python frameworks available <#performance>`_.
        
        * 
          **Fast to code**\ : Increase the speed to develop features by about 200% to 300%. *
        
        * **Fewer bugs**\ : Reduce about 40% of human (developer) induced errors. *
        * **Intuitive**\ : Great editor support. :raw-html-m2r:`<abbr title="also known as auto-complete, autocompletion, IntelliSense">Completion</abbr>` everywhere. Less time debugging.
        * **Easy**\ : Designed to be easy to use and learn. Less time reading docs.
        * **Short**\ : Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.
        * **Robust**\ : Get production-ready code. With automatic interactive documentation.
        * **Standards-based**\ : Based on (and fully compatible with) the open standards for APIs: :raw-html-m2r:`<a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a>` (previously known as Swagger) and :raw-html-m2r:`<a href="https://json-schema.org/" class="external-link" target="_blank">JSON Schema</a>`.
        
        :raw-html-m2r:`<small>* estimation based on tests on an internal development team, building production applications.</small>`
        
        Gold Sponsors
        -------------
        
        
        .. raw:: html
        
           <!-- sponsors -->
        
        
        
        :raw-html-m2r:`<a href="https://www.deta.sh/?ref=fastapi" target="_blank" title="The launchpad for all your (team's) ideas"><img src="https://fastapi.tiangolo.com/img/sponsors/deta.svg"></a>`
        
        
        .. raw:: html
        
           <!-- /sponsors -->
        
        
        
        :raw-html-m2r:`<a href="https://fastapi.tiangolo.com/fastapi-people/#sponsors" class="external-link" target="_blank">Other sponsors</a>`
        
        Opinions
        --------
        
        "\ *[...] I'm using **FastAPI** a ton these days. [...] I'm actually planning to use it for all of my team's **ML services at Microsoft**. Some of them are getting integrated into the core **Windows** product and some **Office** products.*\ "
        
        
        .. raw:: html
        
           <div style="text-align: right; margin-right: 10%;">Kabir Khan - <strong>Microsoft</strong> <a href="https://github.com/tiangolo/fastapi/pull/26" target="_blank"><small>(ref)</small></a></div>
        
        
        ----
        
        "\ *We adopted the **FastAPI** library to spawn a **REST** server that can be queried to obtain **predictions**. [for Ludwig]*\ "
        
        
        .. raw:: html
        
           <div style="text-align: right; margin-right: 10%;">Piero Molino, Yaroslav Dudin, and Sai Sumanth Miryala - <strong>Uber</strong> <a href="https://eng.uber.com/ludwig-v0-2/" target="_blank"><small>(ref)</small></a></div>
        
        
        ----
        
        "\ ***Netflix** is pleased to announce the open-source release of our **crisis management** orchestration framework: **Dispatch**\ ! [built with **FastAPI**\ ]_"
        
        
        .. raw:: html
        
           <div style="text-align: right; margin-right: 10%;">Kevin Glisson, Marc Vilanova, Forest Monsen - <strong>Netflix</strong> <a href="https://netflixtechblog.com/introducing-dispatch-da4b8a2a8072" target="_blank"><small>(ref)</small></a></div>
        
        
        ----
        
        "\ *I’m over the moon excited about **FastAPI**. It’s so fun!*\ "
        
        
        .. raw:: html
        
           <div style="text-align: right; margin-right: 10%;">Brian Okken - <strong><a href="https://pythonbytes.fm/episodes/show/123/time-to-right-the-py-wrongs?time_in_sec=855" target="_blank">Python Bytes</a> podcast host</strong> <a href="https://twitter.com/brianokken/status/1112220079972728832" target="_blank"><small>(ref)</small></a></div>
        
        
        ----
        
        "\ *Honestly, what you've built looks super solid and polished. In many ways, it's what I wanted **Hug** to be - it's really inspiring to see someone build that.*\ "
        
        
        .. raw:: html
        
           <div style="text-align: right; margin-right: 10%;">Timothy Crosley - <strong><a href="https://www.hug.rest/" target="_blank">Hug</a> creator</strong> <a href="https://news.ycombinator.com/item?id=19455465" target="_blank"><small>(ref)</small></a></div>
        
        
        ----
        
        "\ *If you're looking to learn one **modern framework** for building REST APIs, check out **FastAPI** [...] It's fast, easy to use and easy to learn [...]*\ "
        
        "\ *We've switched over to **FastAPI** for our **APIs** [...] I think you'll like it [...]*\ "
        
        
        .. raw:: html
        
           <div style="text-align: right; margin-right: 10%;">Ines Montani - Matthew Honnibal - <strong><a href="https://explosion.ai" target="_blank">Explosion AI</a> founders - <a href="https://spacy.io" target="_blank">spaCy</a> creators</strong> <a href="https://twitter.com/_inesmontani/status/1144173225322143744" target="_blank"><small>(ref)</small></a> - <a href="https://twitter.com/honnibal/status/1144031421859655680" target="_blank"><small>(ref)</small></a></div>
        
        
        ----
        
        **Typer**\ , the FastAPI of CLIs
        ----------------------------------
        
        :raw-html-m2r:`<a href="https://typer.tiangolo.com" target="_blank"><img src="https://typer.tiangolo.com/img/logo-margin/logo-margin-vector.svg" style="width: 20%;"></a>`
        
        If you are building a :raw-html-m2r:`<abbr title="Command Line Interface">CLI</abbr>` app to be used in the terminal instead of a web API, check out :raw-html-m2r:`<a href="https://typer.tiangolo.com/" class="external-link" target="_blank">**Typer**</a>`.
        
        **Typer** is FastAPI's little sibling. And it's intended to be the **FastAPI of CLIs**. ⌨️ 🚀
        
        Requirements
        ------------
        
        Python 3.6+
        
        FastAPI stands on the shoulders of giants:
        
        
        * :raw-html-m2r:`<a href="https://www.starlette.io/" class="external-link" target="_blank">Starlette</a>` for the web parts.
        * :raw-html-m2r:`<a href="https://pydantic-docs.helpmanual.io/" class="external-link" target="_blank">Pydantic</a>` for the data parts.
        
        Installation
        ------------
        
        
        .. raw:: html
        
           <div class="termy">
        
           ```console
           $ pip install fastapi
        
           ---> 100%
           ```
        
           </div>
        
        
        You will also need an ASGI server, for production such as :raw-html-m2r:`<a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a>` or :raw-html-m2r:`<a href="https://gitlab.com/pgjones/hypercorn" class="external-link" target="_blank">Hypercorn</a>`.
        
        
        .. raw:: html
        
           <div class="termy">
        
           ```console
           $ pip install uvicorn
        
           ---> 100%
           ```
        
           </div>
        
        
        Example
        -------
        
        Create it
        ^^^^^^^^^
        
        
        * Create a file ``main.py`` with:
        
        .. code-block:: Python
        
           from typing import Optional
        
           from fastapi import FastAPI
        
           app = FastAPI()
        
        
           @app.get("/")
           def read_root():
               return {"Hello": "World"}
        
        
           @app.get("/items/{item_id}")
           def read_item(item_id: int, q: Optional[str] = None):
               return {"item_id": item_id, "q": q}
        
        
        .. raw:: html
        
           <details markdown="1">
           <summary>Or use <code>async def</code>...</summary>
        
           If your code uses `async` / `await`, use `async def`:
        
           ```Python hl_lines="9  14"
           from typing import Optional
        
           from fastapi import FastAPI
        
           app = FastAPI()
        
        
           @app.get("/")
           async def read_root():
               return {"Hello": "World"}
        
        
           @app.get("/items/{item_id}")
           async def read_item(item_id: int, q: Optional[str] = None):
               return {"item_id": item_id, "q": q}
           ```
        
           **Note**:
        
           If you don't know, check the _"In a hurry?"_ section about <a href="https://fastapi.tiangolo.com/async/#in-a-hurry" target="_blank">`async` and `await` in the docs</a>.
        
           </details>
        
        
        Run it
        ^^^^^^
        
        Run the server with:
        
        
        .. raw:: html
        
           <div class="termy">
        
           ```console
           $ uvicorn main:app --reload
        
           INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
           INFO:     Started reloader process [28720]
           INFO:     Started server process [28722]
           INFO:     Waiting for application startup.
           INFO:     Application startup complete.
           ```
        
           </div>
        
        
        
        .. raw:: html
        
           <details markdown="1">
           <summary>About the command <code>uvicorn main:app --reload</code>...</summary>
        
           The command `uvicorn main:app` refers to:
        
           * `main`: the file `main.py` (the Python "module").
           * `app`: the object created inside of `main.py` with the line `app = FastAPI()`.
           * `--reload`: make the server restart after code changes. Only do this for development.
        
           </details>
        
        
        Check it
        ^^^^^^^^
        
        Open your browser at :raw-html-m2r:`<a href="http://127.0.0.1:8000/items/5?q=somequery" class="external-link" target="_blank">http://127.0.0.1:8000/items/5?q=somequery</a>`.
        
        You will see the JSON response as:
        
        .. code-block:: JSON
        
           {"item_id": 5, "q": "somequery"}
        
        You already created an API that:
        
        
        * Receives HTTP requests in the *paths* ``/`` and ``/items/{item_id}``.
        * Both *paths* take ``GET`` :raw-html-m2r:`<em>operations</em>` (also known as HTTP *methods*\ ).
        * The *path* ``/items/{item_id}`` has a *path parameter* ``item_id`` that should be an ``int``.
        * The *path* ``/items/{item_id}`` has an optional ``str`` *query parameter* ``q``.
        
        Interactive API docs
        ^^^^^^^^^^^^^^^^^^^^
        
        Now go to :raw-html-m2r:`<a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>`.
        
        You will see the automatic interactive API documentation (provided by :raw-html-m2r:`<a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">Swagger UI</a>`\ ):
        
        
        .. image:: https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png
           :target: https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png
           :alt: Swagger UI
        
        
        Alternative API docs
        ^^^^^^^^^^^^^^^^^^^^
        
        And now, go to :raw-html-m2r:`<a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>`.
        
        You will see the alternative automatic documentation (provided by :raw-html-m2r:`<a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">ReDoc</a>`\ ):
        
        
        .. image:: https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png
           :target: https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png
           :alt: ReDoc
        
        
        Example upgrade
        ---------------
        
        Now modify the file ``main.py`` to receive a body from a ``PUT`` request.
        
        Declare the body using standard Python types, thanks to Pydantic.
        
        ```Python hl_lines="4  9-12  25-27"
        from typing import Optional
        
        from fastapi import FastAPI
        from pydantic import BaseModel
        
        app = FastAPI()
        
        class Item(BaseModel):
            name: str
            price: float
            is_offer: Optional[bool] = None
        
        @app.get("/")
        def read_root():
            return {"Hello": "World"}
        
        @app.get("/items/{item_id}")
        def read_item(item_id: int, q: Optional[str] = None):
            return {"item_id": item_id, "q": q}
        
        @app.put("/items/{item_id}")
        def update_item(item_id: int, item: Item):
            return {"item_name": item.name, "item_id": item_id}
        
        .. code-block::
        
        
           The server should reload automatically (because you added `--reload` to the `uvicorn` command above).
        
           ### Interactive API docs upgrade
        
           Now go to <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
        
           * The interactive API documentation will be automatically updated, including the new body:
        
           ![Swagger UI](https://fastapi.tiangolo.com/img/index/index-03-swagger-02.png)
        
           * Click on the button "Try it out", it allows you to fill the parameters and directly interact with the API:
        
           ![Swagger UI interaction](https://fastapi.tiangolo.com/img/index/index-04-swagger-03.png)
        
           * Then click on the "Execute" button, the user interface will communicate with your API, send the parameters, get the results and show them on the screen:
        
           ![Swagger UI interaction](https://fastapi.tiangolo.com/img/index/index-05-swagger-04.png)
        
           ### Alternative API docs upgrade
        
           And now, go to <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>.
        
           * The alternative documentation will also reflect the new query parameter and body:
        
           ![ReDoc](https://fastapi.tiangolo.com/img/index/index-06-redoc-02.png)
        
           ### Recap
        
           In summary, you declare **once** the types of parameters, body, etc. as function parameters. 
        
           You do that with standard modern Python types.
        
           You don't have to learn a new syntax, the methods or classes of a specific library, etc.
        
           Just standard **Python 3.6+**.
        
           For example, for an `int`:
        
           ```Python
           item_id: int
        
        or for a more complex ``Item`` model:
        
        .. code-block:: Python
        
           item: Item
        
        ...and with that single declaration you get:
        
        
        
        * Editor support, including:
        
          * Completion.
          * Type checks.
        
        * Validation of data:
        
          * Automatic and clear errors when the data is invalid.
          * Validation even for deeply nested JSON objects.
        
        * :raw-html-m2r:`<abbr title="also known as: serialization, parsing, marshalling">Conversion</abbr>` of input data: coming from the network to Python data and types. Reading from:
        
          * JSON.
          * Path parameters.
          * Query parameters.
          * Cookies.
          * Headers.
          * Forms.
          * Files.
        
        * :raw-html-m2r:`<abbr title="also known as: serialization, parsing, marshalling">Conversion</abbr>` of output data: converting from Python data and types to network data (as JSON):
        
          * Convert Python types (\ ``str``\ , ``int``\ , ``float``\ , ``bool``\ , ``list``\ , etc).
          * ``datetime`` objects.
          * ``UUID`` objects.
          * Database models.
          * ...and many more.
        
        * Automatic interactive API documentation, including 2 alternative user interfaces:
        
          * Swagger UI.
          * ReDoc.
        
        ----
        
        Coming back to the previous code example, **FastAPI** will:
        
        
        * Validate that there is an ``item_id`` in the path for ``GET`` and ``PUT`` requests.
        * Validate that the ``item_id`` is of type ``int`` for ``GET`` and ``PUT`` requests.
        
          * If it is not, the client will see a useful, clear error.
        
        * Check if there is an optional query parameter named ``q`` (as in ``http://127.0.0.1:8000/items/foo?q=somequery``\ ) for ``GET`` requests.
        
          * As the ``q`` parameter is declared with ``= None``\ , it is optional.
          * Without the ``None`` it would be required (as is the body in the case with ``PUT``\ ).
        
        * For ``PUT`` requests to ``/items/{item_id}``\ , Read the body as JSON:
        
          * Check that it has a required attribute ``name`` that should be a ``str``. 
          * Check that it has a required attribute ``price`` that has to be a ``float``.
          * Check that it has an optional attribute ``is_offer``\ , that should be a ``bool``\ , if present.
          * All this would also work for deeply nested JSON objects.
        
        * Convert from and to JSON automatically.
        * Document everything with OpenAPI, that can be used by:
        
          * Interactive documentation systems.
          * Automatic client code generation systems, for many languages.
        
        * Provide 2 interactive documentation web interfaces directly.
        
        ----
        
        We just scratched the surface, but you already get the idea of how it all works.
        
        Try changing the line with:
        
        .. code-block:: Python
        
               return {"item_name": item.name, "item_id": item_id}
        
        ...from:
        
        
        .. code-block:: Python
        
                   ... "item_name": item.name ...
        
        ...to:
        
        
        .. code-block:: Python
        
                   ... "item_price": item.price ...
        
        ...and see how your editor will auto-complete the attributes and know their types:
        
        
        
        .. image:: https://fastapi.tiangolo.com/img/vscode-completion.png
           :target: https://fastapi.tiangolo.com/img/vscode-completion.png
           :alt: editor support
        
        
        For a more complete example including more features, see the :raw-html-m2r:`<a href="https://fastapi.tiangolo.com/tutorial/">Tutorial - User Guide</a>`.
        
        **Spoiler alert**\ : the tutorial - user guide includes:
        
        
        * Declaration of **parameters** from other different places as: **headers**\ , **cookies**\ , **form fields** and **files**.
        * How to set **validation constraints** as ``maximum_length`` or ``regex``.
        * A very powerful and easy to use **\ :raw-html-m2r:`<abbr title="also known as components, resources, providers, services, injectables">Dependency Injection</abbr>`\ ** system.
        * Security and authentication, including support for **OAuth2** with **JWT tokens** and **HTTP Basic** auth.
        * More advanced (but equally easy) techniques for declaring **deeply nested JSON models** (thanks to Pydantic).
        * Many extra features (thanks to Starlette) as:
        
          * **WebSockets**
          * **GraphQL**
          * extremely easy tests based on ``requests`` and ``pytest``
          * **CORS**
          * **Cookie Sessions**
          * ...and more.
        
        Performance
        -----------
        
        Independent TechEmpower benchmarks show **FastAPI** applications running under Uvicorn as :raw-html-m2r:`<a href="https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=query&l=zijzen-7" class="external-link" target="_blank">one of the fastest Python frameworks available</a>`\ , only below Starlette and Uvicorn themselves (used internally by FastAPI). (*)
        
        To understand more about it, see the section :raw-html-m2r:`<a href="https://fastapi.tiangolo.com/benchmarks/" class="internal-link" target="_blank">Benchmarks</a>`.
        
        Optional Dependencies
        ---------------------
        
        Used by Pydantic:
        
        
        * :raw-html-m2r:`<a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a>` - for faster JSON :raw-html-m2r:`<abbr title="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>`.
        * :raw-html-m2r:`<a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email_validator</code></a>` - for email validation.
        
        Used by Starlette:
        
        
        * :raw-html-m2r:`<a href="https://requests.readthedocs.io" target="_blank"><code>requests</code></a>` - Required if you want to use the ``TestClient``.
        * :raw-html-m2r:`<a href="https://github.com/Tinche/aiofiles" target="_blank"><code>aiofiles</code></a>` - Required if you want to use ``FileResponse`` or ``StaticFiles``.
        * :raw-html-m2r:`<a href="https://jinja.palletsprojects.com" target="_blank"><code>jinja2</code></a>` - Required if you want to use the default template configuration.
        * :raw-html-m2r:`<a href="https://andrew-d.github.io/python-multipart/" target="_blank"><code>python-multipart</code></a>` - Required if you want to support form :raw-html-m2r:`<abbr title="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>`\ , with ``request.form()``.
        * :raw-html-m2r:`<a href="https://pythonhosted.org/itsdangerous/" target="_blank"><code>itsdangerous</code></a>` - Required for ``SessionMiddleware`` support.
        * :raw-html-m2r:`<a href="https://pyyaml.org/wiki/PyYAMLDocumentation" target="_blank"><code>pyyaml</code></a>` - Required for Starlette's ``SchemaGenerator`` support (you probably don't need it with FastAPI).
        * :raw-html-m2r:`<a href="https://graphene-python.org/" target="_blank"><code>graphene</code></a>` - Required for ``GraphQLApp`` support.
        * :raw-html-m2r:`<a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a>` - Required if you want to use ``UJSONResponse``.
        
        Used by FastAPI / Starlette:
        
        
        * :raw-html-m2r:`<a href="https://www.uvicorn.org" target="_blank"><code>uvicorn</code></a>` - for the server that loads and serves your application.
        * :raw-html-m2r:`<a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a>` - Required if you want to use ``ORJSONResponse``.
        
        You can install all of these with ``pip install fastapi[all]``.
        
        License
        -------
        
        This project is licensed under the terms of the MIT license.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.6
Provides-Extra: all
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
