Add custom CLI for service startup (#697)

* Add custom CLI for service startup

* Remove redundant scripts

* Fix lint

Author: wu-clan

backend/README.md

@@ -72,7 +72,7 @@
 >
 > It is recommended to execute under the backend directory, and chmod authorization may be required
 
-- `pre_start.sh`: Perform automatic database migration and create database tables
+- `pre_start.sh`: Perform automatic database migration
 
 - `celery-start.sh`: For celery docker script, implementation is not recommended
 

backend/__init__.py

@@ -1,2 +1,10 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+
+__version__ = '1.5.2'
+
+from backend.utils.console import console
+
+
+def get_version() -> str | None:
+    console.print(f'\n[cyan]{__version__}[/]')

backend/cli.py

@@ -0,0 +1,101 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from dataclasses import dataclass
+from typing import Annotated
+
+import uvicorn
+
+from cappa import Arg, Subcommands, invoke
+from rich.panel import Panel
+from rich.progress import (
+    Progress,
+    SpinnerColumn,
+    TextColumn,
+    TimeElapsedColumn,
+)
+from rich.text import Text
+
+from backend import console, get_version
+from backend.core.conf import settings
+from backend.plugin.tools import get_plugins, install_requirements
+
+
+def run(host: str, port: int, reload: bool, workers: int | None) -> None:
+    console.print(Text('检测插件依赖...', style='bold cyan'))
+
+    plugins = get_plugins()
+
+    with Progress(
+        SpinnerColumn(finished_text='[bold green]插件依赖安装完成[/]'),
+        TextColumn('[green]{task.completed}/{task.total}[/]'),
+        TimeElapsedColumn(),
+        console=console,
+    ) as progress:
+        task = progress.add_task('安装插件依赖...', total=len(plugins))
+        for i, plugin in enumerate(plugins):
+            install_requirements(plugin)
+            progress.advance(task)
+
+    url = f'http://{host}:{port}'
+    docs_url = url + settings.FASTAPI_DOCS_URL
+    redoc_url = url + settings.FASTAPI_REDOC_URL
+    openapi_url = url + settings.FASTAPI_OPENAPI_URL
+
+    console.print(Text('启动 fba 服务...', style='bold magenta'))
+
+    panel_content = Text()
+    panel_content.append(f'📝 Swagger 文档: {docs_url}\n', style='blue')
+    panel_content.append(f'📚 Redoc   文档: {redoc_url}\n', style='yellow')
+    panel_content.append(f'📡 OpenAPI JSON: {openapi_url}\n', style='green')
+    panel_content.append(
+        '🌍 fba 官方文档: https://fastapi-practices.github.io/fastapi_best_architecture_docs/',
+        style='cyan',
+    )
+
+    console.print(Panel(panel_content, title='fba 服务信息', border_style='purple', padding=(1, 2)))
+    uvicorn.run(app='backend.main:app', host=host, port=port, reload=reload, workers=workers)
+
+
+@dataclass
+class Run:
+    host: Annotated[
+        str,
+        Arg(
+            long=True,
+            default='127.0.0.1',
+            help='提供服务的主机 IP 地址，对于本地开发，请使用 `127.0.0.1`。'
+            '要启用公共访问，例如在局域网中，请使用 `0.0.0.0`',
+        ),
+    ]
+    port: Annotated[
+        int,
+        Arg(long=True, default=8000, help='提供服务的主机端口号'),
+    ]
+    reload: Annotated[
+        bool,
+        Arg(long=True, default=True, help='启用在（代码）文件更改时自动重新加载服务器'),
+    ]
+    workers: Annotated[
+        int | None,
+        Arg(long=True, default=None, help='使用多个工作进程。与 `--reload` 标志互斥'),
+    ]
+
+    def __call__(self):
+        run(host=self.host, port=self.port, reload=self.reload, workers=self.workers)
+
+
+@dataclass
+class FbaCli:
+    version: Annotated[
+        bool,
+        Arg(short='-V', long=True, default=False, help='打印 fba 当前版本号'),
+    ]
+    subcmd: Subcommands[Run | None] = None
+
+    def __call__(self):
+        if self.version:
+            get_version()
+
+
+def main() -> None:
+    invoke(FbaCli)

backend/plugin/tools.py

@@ -251,7 +251,7 @@ def build_final_router() -> APIRouter:
     return main_router
 
 
-def install_requirements(plugin: str) -> None:
+def install_requirements(plugin: str | None) -> None:
     """
     安装插件依赖
 
@@ -268,8 +268,8 @@ def install_requirements(plugin: str) -> None:
                 pip_install = [sys.executable, '-m', 'pip', 'install', '-r', requirements_file]
                 if settings.PLUGIN_PIP_CHINA:
                     pip_install.extend(['-i', settings.PLUGIN_PIP_INDEX_URL])
-                subprocess.check_call(ensurepip_install)
-                subprocess.check_call(pip_install)
+                subprocess.check_call(ensurepip_install, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+                subprocess.check_call(pip_install, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
             except subprocess.CalledProcessError as e:
                 raise PluginInjectError(f'插件 {plugin} 依赖安装失败：{e.stderr}') from e
 

backend/pre_start.sh

@@ -3,5 +3,3 @@
 alembic revision --autogenerate
 
 alembic upgrade head
-
-python3 ./scripts/init_data.py

backend/scripts/init_data.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from rich import get_console
+
+console = get_console()

backend/utils/console.py

@@ -1,6 +1,5 @@
 [project]
 name = "fastapi_best_architecture"
-version = "0.0.1"
 description = """
 A RBAC (Role-Based Access Control) permission control system built on FastAPI, featuring a unique pseudo-three-tier
 architecture design, with built-in basic implementation of fastapi admin as a template library, free and open-source.
@@ -10,7 +9,8 @@ authors = [
 ]
 readme = "README.md"
 license = { text = "MIT" }
-requires-python = ">=3.10,<3.13"
+requires-python = ">=3.10"
+dynamic = ['version']
 dependencies = [
     "aiofiles>=24.1.0",
     "alembic>=1.14.1",
@@ -19,14 +19,14 @@ dependencies = [
     "asyncmy>=0.2.10",
     "asyncpg>=0.30.0",
     "bcrypt>=4.2.1",
+    "cappa>=0.28.0",
     "celery==5.3.6",
     # When celery version < 6.0.0
     # https://github.com/celery/celery/issues/7874
     "celery-aio-pool==0.1.0rc8",
     "cryptography>=44.0.0",
     "dulwich>=0.22.8",
     "fast-captcha>=0.3.2",
-    "fastapi-cli==0.0.5",
     "fastapi-limiter>=0.1.6",
     "fastapi-pagination>=0.13.0",
     "fastapi[standard]==0.115.11",
@@ -66,10 +66,22 @@ server = [
 ]
 
 [tool.uv]
-package = false
 python-downloads = "manual"
 default-groups = ["dev", "lint"]
 
 [[tool.uv.index]]
 name = "aliyun"
 url = "https://mirrors.aliyun.com/pypi/simple"
+
+[tool.hatch.build.targets.wheel]
+packages = ["backend"]
+
+[tool.hatch.version]
+path = "backend/__init__.py"
+
+[project.scripts]
+fba = "backend.cli:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

pyproject.toml

@@ -1,5 +1,6 @@
 # This file was autogenerated by uv via the following command:
 #    uv export -o requirements.txt --no-hashes
+-e .
 aiofiles==24.1.0
     # via fastapi-best-architecture
 alembic==1.15.1
@@ -31,6 +32,8 @@ bidict==0.23.1
     # via python-socketio
 billiard==4.2.1
     # via celery
+cappa==0.28.0
+    # via fastapi-best-architecture
 celery==5.3.6
     # via
     #   celery-aio-pool
@@ -92,9 +95,7 @@ fastapi==0.115.11
     #   fastapi-limiter
     #   fastapi-pagination
 fastapi-cli==0.0.5
-    # via
-    #   fastapi
-    #   fastapi-best-architecture
+    # via fastapi
 fastapi-limiter==0.1.6
     # via fastapi-best-architecture
 fastapi-pagination==0.13.0
@@ -228,7 +229,9 @@ redis==5.2.1
     #   fastapi-best-architecture
     #   fastapi-limiter
 rich==13.9.4
-    # via typer
+    # via
+    #   cappa
+    #   typer
 rsa==4.9
     # via python-jose
 rtoml==0.12.0
@@ -264,19 +267,23 @@ tomli==2.2.1 ; python_full_version < '3.11'
     # via pytest
 tornado==6.4.2
     # via flower
+type-lens==0.2.3
+    # via cappa
 typer==0.15.2
     # via fastapi-cli
 typing-extensions==4.13.0
     # via
     #   alembic
     #   anyio
     #   asgiref
+    #   cappa
     #   fastapi
     #   fastapi-pagination
     #   pydantic
     #   pydantic-core
     #   rich
     #   sqlalchemy
+    #   type-lens
     #   typer
     #   typing-inspection
     #   uvicorn