loongson/pypi/: fastapi-0.78.0 metadata and description

Homepage Simple index

FastAPI framework, high performance, easy to learn, fast to code, ready for production

author Sebastián Ramírez
author_email tiangolo@gmail.com
classifiers
  • Intended Audience :: Information Technology
  • Intended Audience :: System Administrators
  • Operating System :: OS Independent
  • Programming Language :: Python :: 3
  • Programming Language :: Python
  • Topic :: Internet
  • Topic :: Software Development :: Libraries :: Application Frameworks
  • Topic :: Software Development :: Libraries :: Python Modules
  • Topic :: Software Development :: Libraries
  • Topic :: Software Development
  • Typing :: Typed
  • Development Status :: 4 - Beta
  • Environment :: Web Environment
  • Framework :: AsyncIO
  • Framework :: FastAPI
  • Intended Audience :: Developers
  • License :: OSI Approved :: MIT License
  • Programming Language :: Python :: 3 :: Only
  • Programming Language :: Python :: 3.6
  • Programming Language :: Python :: 3.7
  • Programming Language :: Python :: 3.8
  • Programming Language :: Python :: 3.9
  • Programming Language :: Python :: 3.10
  • Topic :: Internet :: WWW/HTTP :: HTTP Servers
  • Topic :: Internet :: WWW/HTTP
description_content_type text/markdown
project_urls
  • Documentation, https://fastapi.tiangolo.com/
provides_extras test
requires_dist
  • starlette==0.19.1
  • pydantic >=1.6.2,!=1.7,!=1.7.1,!=1.7.2,!=1.7.3,!=1.8,!=1.8.1,<2.0.0
  • requests >=2.24.0,<3.0.0 ; extra == "all"
  • jinja2 >=2.11.2,<4.0.0 ; extra == "all"
  • python-multipart >=0.0.5,<0.0.6 ; extra == "all"
  • itsdangerous >=1.1.0,<3.0.0 ; extra == "all"
  • pyyaml >=5.3.1,<7.0.0 ; extra == "all"
  • ujson >=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0,<6.0.0 ; extra == "all"
  • orjson >=3.2.1,<4.0.0 ; extra == "all"
  • email_validator >=1.1.1,<2.0.0 ; extra == "all"
  • uvicorn[standard] >=0.12.0,<0.18.0 ; extra == "all"
  • python-jose[cryptography] >=3.3.0,<4.0.0 ; extra == "dev"
  • passlib[bcrypt] >=1.7.2,<2.0.0 ; extra == "dev"
  • autoflake >=1.4.0,<2.0.0 ; extra == "dev"
  • flake8 >=3.8.3,<4.0.0 ; extra == "dev"
  • uvicorn[standard] >=0.12.0,<0.18.0 ; extra == "dev"
  • pre-commit >=2.17.0,<3.0.0 ; extra == "dev"
  • mkdocs >=1.1.2,<2.0.0 ; extra == "doc"
  • mkdocs-material >=8.1.4,<9.0.0 ; extra == "doc"
  • mdx-include >=1.4.1,<2.0.0 ; extra == "doc"
  • mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0 ; extra == "doc"
  • typer >=0.4.1,<0.5.0 ; extra == "doc"
  • pyyaml >=5.3.1,<7.0.0 ; extra == "doc"
  • pytest >=6.2.4,<7.0.0 ; extra == "test"
  • pytest-cov >=2.12.0,<4.0.0 ; extra == "test"
  • mypy ==0.910 ; extra == "test"
  • flake8 >=3.8.3,<4.0.0 ; extra == "test"
  • black == 22.3.0 ; extra == "test"
  • isort >=5.0.6,<6.0.0 ; extra == "test"
  • requests >=2.24.0,<3.0.0 ; extra == "test"
  • httpx >=0.14.0,<0.19.0 ; extra == "test"
  • email_validator >=1.1.1,<2.0.0 ; extra == "test"
  • sqlalchemy >=1.3.18,<1.5.0 ; extra == "test"
  • peewee >=3.13.3,<4.0.0 ; extra == "test"
  • databases[sqlite] >=0.3.2,<0.6.0 ; extra == "test"
  • orjson >=3.2.1,<4.0.0 ; extra == "test"
  • ujson >=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0,<6.0.0 ; extra == "test"
  • python-multipart >=0.0.5,<0.0.6 ; extra == "test"
  • flask >=1.1.2,<3.0.0 ; extra == "test"
  • anyio[trio] >=3.2.1,<4.0.0 ; extra == "test"
  • types-ujson ==4.2.1 ; extra == "test"
  • types-orjson ==3.6.2 ; extra == "test"
  • types-dataclasses ==0.6.5 ; extra == "test" and ( python_version<'3.7')
requires_python >=3.6.1

Because this project isn't in the mirror_whitelist, no releases from root/pypi are included.

File Tox results History
fastapi-0.78.0-py3-none-any.whl
Size
53 KB
Type
Python Wheel
Python
3

FastAPI

FastAPI framework, high performance, easy to learn, fast to code, ready for production

Test Coverage Package version Supported Python versions


Documentation: https://fastapi.tiangolo.com

Source Code: https://github.com/tiangolo/fastapi


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:

<small>* estimation based on tests on an internal development team, building production applications.</small>

Sponsors

Other sponsors

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

Kabir Khan - Microsoft <small>(ref)</small>

"We adopted the FastAPI library to spawn a REST server that can be queried to obtain predictions. [for Ludwig]"

Piero Molino, Yaroslav Dudin, and Sai Sumanth Miryala - Uber <small>(ref)</small>

"Netflix is pleased to announce the open-source release of our crisis management orchestration framework: Dispatch! [built with FastAPI]"

Kevin Glisson, Marc Vilanova, Forest Monsen - Netflix <small>(ref)</small>

"I’m over the moon excited about FastAPI. It’s so fun!"

Brian Okken - Python Bytes podcast host <small>(ref)</small>

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

Timothy Crosley - Hug creator <small>(ref)</small>

"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 [...]"

Ines Montani - Matthew Honnibal - Explosion AI founders - spaCy creators <small>(ref)</small> - <small>(ref)</small>

Typer, the FastAPI of CLIs

If you are building a CLI app to be used in the terminal instead of a web API, check out Typer.

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:

Installation

$ pip install fastapi

---> 100%

You will also need an ASGI server, for production such as Uvicorn or Hypercorn.

$ pip install "uvicorn[standard]"

---> 100%

Example

Create it

from typing import Union

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: Union[str, None] = None):
    return {"item_id": item_id, "q": q}
Or use async def...

If your code uses async / await, use async def:

from typing import Union

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: Union[str, None] = None):
    return {"item_id": item_id, "q": q}

Note:

If you don't know, check the "In a hurry?" section about async and await in the docs.

Run it

Run the server with:

$ 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.
About the command uvicorn main:app --reload...

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.

Check it

Open your browser at http://127.0.0.1:8000/items/5?q=somequery.

You will see the JSON response as:

{"item_id": 5, "q": "somequery"}

You already created an API that:

Interactive API docs

Now go to http://127.0.0.1:8000/docs.

You will see the automatic interactive API documentation (provided by Swagger UI):

Swagger UI

Alternative API docs

And now, go to http://127.0.0.1:8000/redoc.

You will see the alternative automatic documentation (provided by ReDoc):

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.

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    price: float
    is_offer: Union[bool, None] = None


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = 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}

The server should reload automatically (because you added --reload to the uvicorn command above).

Interactive API docs upgrade

Now go to http://127.0.0.1:8000/docs.

Swagger UI

Swagger UI interaction

Swagger UI interaction

Alternative API docs upgrade

And now, go to http://127.0.0.1:8000/redoc.

ReDoc

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:

item_id: int

or for a more complex Item model:

item: Item

...and with that single declaration you get:


Coming back to the previous code example, FastAPI will:


We just scratched the surface, but you already get the idea of how it all works.

Try changing the line with:

    return {"item_name": item.name, "item_id": item_id}

...from:

        ... "item_name": item.name ...

...to:

        ... "item_price": item.price ...

...and see how your editor will auto-complete the attributes and know their types:

editor support

For a more complete example including more features, see the Tutorial - User Guide.

Spoiler alert: the tutorial - user guide includes:

Performance

Independent TechEmpower benchmarks show FastAPI applications running under Uvicorn as one of the fastest Python frameworks available, only below Starlette and Uvicorn themselves (used internally by FastAPI). (*)

To understand more about it, see the section Benchmarks.

Optional Dependencies

Used by Pydantic:

Used by Starlette:

Used by FastAPI / Starlette:

You can install all of these with pip install "fastapi[all]".

License

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