{"author":null,"author_email":"=?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= ","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Framework :: FastAPI","Intended Audience :: Developers","Intended Audience :: Information Technology","Intended Audience :: System Administrators","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Software Development","Topic :: Software Development :: Libraries","Topic :: Software Development :: Libraries :: Application Frameworks","Topic :: Software Development :: Libraries :: Python Modules","Typing :: Typed"],"description":"# FastAPI CLI\n\n\n $\"Test\"$ \n\n\n $\"Publish\"$ \n\n\n $\"Coverage\"$ \n \n $\"Package$ \n\n\n---\n\n**Source Code**: https://github.com/fastapi/fastapi-cli\n\n---\n\nRun and manage FastAPI apps from the command line with FastAPI CLI. 🚀\n\n## Description\n\n**FastAPI CLI** is a command line program `fastapi` that you can use to serve your FastAPI app, manage your FastAPI project, and more.\n\nWhen you install FastAPI (e.g. with `pip install \"fastapi[standard]\"`), it includes a package called `fastapi-cli`, this package provides the `fastapi` command in the terminal.\n\nTo run your FastAPI app for development, you can use the `fastapi dev` command:\n\n

\n\n```console\n$ fastapi dev main.py\n\n FastAPI Starting development server 🚀\n\n Searching for package file structure from directories with __init__.py files\n Importing from /home/user/code/awesomeapp\n\n module 🐍 main.py\n\n code Importing the FastAPI app object from the module with the following code:\n\n from main import app\n\n app Using import string: main:app\n\n server Server started at http://127.0.0.1:8000\n server Documentation at http://127.0.0.1:8000/docs\n\n tip Running in development mode, for production use: fastapi run\n\n Logs:\n\n INFO Will watch for changes in these directories: ['/home/user/code/awesomeapp']\n INFO Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)\n INFO Started reloader process [4106097] using WatchFiles\n INFO Started server process [4106120]\n INFO Waiting for application startup.\n INFO Application startup complete.\n```\n\n

\n\nThat command line program called `fastapi` is **FastAPI CLI**.\n\nFastAPI CLI takes the path to your Python program and automatically detects the variable with the FastAPI (commonly named `app`) and how to import it, and then serves it.\n\nFor production you would use `fastapi run` instead. 🚀\n\nInternally, **FastAPI CLI** uses Uvicorn, a high-performance, production-ready, ASGI server. 😎\n\n## `fastapi dev`\n\nWhen you run `fastapi dev`, it will run on development mode.\n\nBy default, it will have **auto-reload** enabled, so it will automatically reload the server when you make changes to your code. This is resource intensive and could be less stable than without it, you should only use it for development.\n\nBy default it will listen on the IP address `127.0.0.1`, which is the IP for your machine to communicate with itself alone (`localhost`).\n\n## `fastapi run`\n\nWhen you run `fastapi run`, it will run on production mode by default.\n\nIt will have **auto-reload disabled** by default.\n\nIt will listen on the IP address `0.0.0.0`, which means all the available IP addresses, this way it will be publicly accessible to anyone that can communicate with the machine. This is how you would normally run it in production, for example, in a container.\n\nIn most cases you would (and should) have a \"termination proxy\" handling HTTPS for you on top, this will depend on how you deploy your application, your provider might do this for you, or you might need to set it up yourself. You can learn more about it in the FastAPI Deployment documentation.\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":null,"license":"MIT","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"fastapi-cli","package_url":"https://pypi.org/project/fastapi-cli/","platform":null,"project_url":"https://pypi.org/project/fastapi-cli/","project_urls":{"Changelog":"https://github.com/fastapi/fastapi-cli/blob/main/release-notes.md","Documentation":"https://fastapi.tiangolo.com/fastapi-cli/","Homepage":"https://github.com/fastapi/fastapi-cli","Issues":"https://github.com/fastapi/fastapi-cli/issues","Repository":"https://github.com/fastapi/fastapi-cli"},"provides_extra":["standard"],"release_url":"https://pypi.org/project/fastapi-cli/0.0.7/","requires_dist":["typer>=0.12.3","uvicorn[standard]>=0.15.0","rich-toolkit>=0.11.1","uvicorn[standard]>=0.15.0; extra == \"standard\""],"requires_python":">=3.8","summary":"Run and manage FastAPI apps from the command line with FastAPI CLI. 🚀","version":"0.0.7","yanked":false,"yanked_reason":null}

Dependencies of fastapi-cli (3).
Dependency	Optional
rich-toolkit	false
typer	false
uvicorn	false

Package search

fastapi-cli

project_urls

Dependencies

All package metadata

Releases