Skip to main content

Run and manage FastAPI apps from the command line with FastAPI CLI. 🚀

Project description

FastAPI CLI

Test Publish Coverage Package version

Source Code: https://github.com/fastapi/fastapi-cli


Run and manage FastAPI apps from the command line with FastAPI CLI. 🚀

Description

FastAPI CLI is a command line program fastapi that you can use to serve your FastAPI app, manage your FastAPI project, and more.

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

To run your FastAPI app for development, you can use the fastapi dev command:

$ fastapi dev main.py

   FastAPI   Starting development server 🚀

             Searching for package file structure from directories with __init__.py files
             Importing from /home/user/code/awesomeapp

    module   🐍 main.py

      code   Importing the FastAPI app object from the module with the following code:

             from main import app

       app   Using import string: main:app

    server   Server started at http://127.0.0.1:8000
    server   Documentation at http://127.0.0.1:8000/docs

       tip   Running in development mode, for production use: fastapi run

             Logs:

      INFO   Will watch for changes in these directories: ['/home/user/code/awesomeapp']
      INFO   Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
      INFO   Started reloader process [4106097] using WatchFiles
      INFO   Started server process [4106120]
      INFO   Waiting for application startup.
      INFO   Application startup complete.

That command line program called fastapi is FastAPI CLI.

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

For production you would use fastapi run instead. 🚀

Internally, FastAPI CLI uses Uvicorn, a high-performance, production-ready, ASGI server. 😎

fastapi dev

When you run fastapi dev, it will run on development mode.

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

By 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).

fastapi run

When you run fastapi run, it will run on production mode by default.

It will have auto-reload disabled by default.

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

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

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastapi_cli-0.0.8.tar.gz (16.9 kB view details)

Uploaded Source

Built Distribution

fastapi_cli-0.0.8-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_cli-0.0.8.tar.gz.

File metadata

  • Download URL: fastapi_cli-0.0.8.tar.gz
  • Upload date:
  • Size: 16.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for fastapi_cli-0.0.8.tar.gz
Algorithm Hash digest
SHA256 2360f2989b1ab4a3d7fc8b3a0b20e8288680d8af2e31de7c38309934d7f8a0ee
MD5 bac6189c7fe7b1d195668330c4dcea74
BLAKE2b-256 c6943ef75d9c7c32936ecb539b9750ccbdc3d2568efd73b1cb913278375f4533

See more details on using hashes here.

Provenance

The following attestation bundles were made for fastapi_cli-0.0.8.tar.gz:

Publisher: publish.yml on fastapi/fastapi-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fastapi_cli-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: fastapi_cli-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for fastapi_cli-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 0ea95d882c85b9219a75a65ab27e8da17dac02873e456850fa0a726e96e985eb
MD5 ebfb949568b55f249869b25a805b8e2f
BLAKE2b-256 e03f6ad3103c5f59208baf4c798526daea6a74085bb35d1c161c501863470476

See more details on using hashes here.

Provenance

The following attestation bundles were made for fastapi_cli-0.0.8-py3-none-any.whl:

Publisher: publish.yml on fastapi/fastapi-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page