Skip to main content

No project description provided

Project description

Fastapi CLI

在使用FastAPI前,我个人使用Flask居多,比较喜欢Flask的CLI,使用起来比较方便,这个项目就是解决FastAPI没有CLI的问题

使用它自动加载项目中已有的Typer实例

使用前

假设我们的CLI代码在下面的路径app/cli/init.py

import typer

app = typer.Typer()

@app.command()
def version():
    return "1.0.0"

为了方便执行,我们需要在项目根目录新增一个入口文件如cli.py并添加下面的内容

from app.cli import app

if __name__ == __main__:
    app()

最后执行

python cli.py --help

使用后

使用fastcli由于app.cli:app在默认路径下,因此会自动加载,我们只需要运行下面的命令即可

fastcli --help

安装使用

安装

pip install fastapi-fastcli

查看路由列表

fastcli routes

img

启动FastAPI应用

fastcli run

img

在运行时所在的目录 查找下列路径

- app.commands:app
- app.cli:app
- cli:app
- main:cli
- manage:cli
- app:cli

你也通过环境变量 TYPER_APP指定

功能

  • 查看路由
  • 启动FastAPI应用(uvicron)

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_fastcli-0.1.1.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

fastapi_fastcli-0.1.1-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_fastcli-0.1.1.tar.gz.

File metadata

  • Download URL: fastapi_fastcli-0.1.1.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.12 Linux/5.15.0-83-generic

File hashes

Hashes for fastapi_fastcli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 89e83e5ec33956508fe91f52b599551c194427e676c8372575f3ac2feaca97a2
MD5 2f21b34495acceeed53cee7fd96be3aa
BLAKE2b-256 5c8b375a5fb2dcb767f3ab7b7692190e57915ac93eca7cdb5893e0ef49b8d602

See more details on using hashes here.

File details

Details for the file fastapi_fastcli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: fastapi_fastcli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.12 Linux/5.15.0-83-generic

File hashes

Hashes for fastapi_fastcli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a8a93aff76daa109a3d4f2ec4a3bb39ee6c5702f2da4aac4b66aa4b07b713e11
MD5 f6a9b3e48a21c6bf3dd9e6329dcec96b
BLAKE2b-256 a2ed3c334665daf0db3b81f24c7762c899789bbd8f66cfbed0e9d37571dba11c

See more details on using hashes here.

Supported by

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