aury-boot 0.0.12__tar.gz → 0.0.14__tar.gz

{aury_boot-0.0.12 → aury_boot-0.0.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aury-boot
-Version: 0.0.12
+Version: 0.0.14
 Summary: Aury Boot - 基于 FastAPI 生态的企业级 API 开发框架
 Requires-Python: >=3.13
 Requires-Dist: alembic>=1.17.2

{aury_boot-0.0.12 → aury_boot-0.0.14}/aury/boot/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.12'
-__version_tuple__ = version_tuple = (0, 0, 12)
+__version__ = version = '0.0.14'
+__version_tuple__ = version_tuple = (0, 0, 14)
 
 __commit_id__ = commit_id = None

{aury_boot-0.0.12 → aury_boot-0.0.14}/aury/boot/commands/docs.py

@@ -83,8 +83,15 @@ def _detect_project_info(project_dir: Path) -> dict[str, str]:
 def _render_template(template_name: str, context: dict[str, str]) -> str:
     """渲染模板。
     
-    支持根目录模板和 aury_docs/ 子目录模板。
+    支持根目录模板、aury_docs/ 子目录模板，且 .env.example 复用 init.py 的 env_templates 逻辑。
     """
+    # 特殊处理 env.example.tpl（通过 init.py 的 env_templates 目录合并生成）
+    if template_name == "env.example.tpl":
+        from .init import _read_env_template  # 复用初始化脚手架的 env 生成逻辑
+
+        content = _read_env_template()
+        return content.format(**context)
+
     # 先在根目录找
     template_path = TEMPLATES_DIR / template_name
     if not template_path.exists():
@@ -173,6 +180,60 @@ def _get_aury_docs_templates() -> list[Path]:
     return sorted(AURY_DOCS_TPL_DIR.glob("*.md.tpl"))
 
 
+def generate_aury_docs(
+    *,
+    project_dir: Path,
+    context: dict[str, str],
+    force: bool = False,
+    dry_run: bool = False,
+    quiet: bool = False,
+) -> int:
+    """核心实现：根据 aury_docs 模板生成开发文档包。
+
+    被 `aury docs dev` 和 `aury init` 复用，确保生成逻辑一致。
+    返回成功生成的文档数量。
+    """
+    if not quiet:
+        console.print()
+
+    # 确保输出目录存在
+    aury_docs_dir = project_dir / "aury_docs"
+    if not dry_run:
+        aury_docs_dir.mkdir(parents=True, exist_ok=True)
+
+    success_count = 0
+    for tpl_path in _get_aury_docs_templates():
+        try:
+            output_name = tpl_path.stem  # 去掉 .tpl 后缀，保留 .md
+            output_path = aury_docs_dir / output_name
+            content = tpl_path.read_text(encoding="utf-8")
+            content = content.format(**context)
+            # init 直接写文件，不走 rich 提示
+            if quiet:
+                if output_path.exists() and not force and not dry_run:
+                    continue
+                if not dry_run:
+                    output_path.write_text(content, encoding="utf-8")
+                success_count += 1
+            else:
+                if _write_file(output_path, content, force=force, dry_run=dry_run):
+                    success_count += 1
+        except Exception as e:
+            if not quiet:
+                console.print(f"[red]❌ 生成 {tpl_path.name} 失败: {e}[/red]")
+            # 静默模式下（init）忽略单个文档失败
+            continue
+
+    if not quiet:
+        console.print()
+        if dry_run:
+            console.print(f"[dim]🔍 预览模式完成，将生成 {success_count} 个文档到 aury_docs/ 目录[/dim]")
+        else:
+            console.print(f"[green]✨ 完成！成功生成 {success_count} 个文档到 aury_docs/ 目录[/green]")
+
+    return success_count
+
+
 @app.command(name="dev")
 def generate_dev_doc(
     project_dir: Path = typer.Argument(
@@ -198,32 +259,16 @@ def generate_dev_doc(
 ) -> None:
     """生成/更新 aury_docs/ 开发文档包。"""
     context = _detect_project_info(project_dir)
-    
+
     console.print(f"[cyan]📚 检测到项目: {context['project_name']}[/cyan]")
-    console.print()
-    
-    # 确保输出目录存在
-    aury_docs_dir = project_dir / "aury_docs"
-    if not dry_run:
-        aury_docs_dir.mkdir(parents=True, exist_ok=True)
-    
-    success_count = 0
-    for tpl_path in _get_aury_docs_templates():
-        try:
-            output_name = tpl_path.stem  # 去掉 .tpl 后缀，保留 .md
-            output_path = aury_docs_dir / output_name
-            content = tpl_path.read_text(encoding="utf-8")
-            content = content.format(**context)
-            if _write_file(output_path, content, force=force, dry_run=dry_run):
-                success_count += 1
-        except Exception as e:
-            console.print(f"[red]❌ 生成 {tpl_path.name} 失败: {e}[/red]")
-    
-    console.print()
-    if dry_run:
-        console.print(f"[dim]🔍 预览模式完成，将生成 {success_count} 个文档到 aury_docs/ 目录[/dim]")
-    else:
-        console.print(f"[green]✨ 完成！成功生成 {success_count} 个文档到 aury_docs/ 目录[/green]")
+
+    generate_aury_docs(
+        project_dir=project_dir,
+        context=context,
+        force=force,
+        dry_run=dry_run,
+        quiet=False,
+    )
 
 
 @app.command(name="cli")

{aury_boot-0.0.12 → aury_boot-0.0.14}/aury/boot/commands/init.py

@@ -836,25 +836,17 @@ def init(
     else:
         console.print("  [dim]ℹ️  migrations/ 目录已存在，跳过[/dim]")
 
-    # 5. 生成开发文档 (aury_docs/) - 动态扫描模板目录
+    # 5. 生成开发文档 (aury_docs/) - 复用 docs.generate_aury_docs
     console.print("\n[bold]📚 生成开发文档...[/bold]")
-    aury_docs_tpl_dir = TEMPLATES_DIR / "aury_docs"
-    aury_docs_dir = base_path / "aury_docs"
-    aury_docs_dir.mkdir(parents=True, exist_ok=True)
-    docs_count = 0
-    if aury_docs_tpl_dir.exists():
-        for tpl_path in sorted(aury_docs_tpl_dir.glob("*.md.tpl")):
-            output_name = tpl_path.stem  # 去掉 .tpl 后缀，保留 .md
-            output_path = aury_docs_dir / output_name
-            if output_path.exists() and not force:
-                continue
-            try:
-                content = tpl_path.read_text(encoding="utf-8")
-                content = content.format(**template_vars)
-                output_path.write_text(content, encoding="utf-8")
-                docs_count += 1
-            except Exception:
-                pass
+    from .docs import generate_aury_docs
+
+    docs_count = generate_aury_docs(
+        project_dir=base_path,
+        context=template_vars,
+        force=force,
+        dry_run=False,
+        quiet=True,
+    )
     console.print(f"  [green]✅ 已生成 {docs_count} 个文档到 aury_docs/[/green]")
 
     # 6. 生成 Docker 配置

{aury_boot-0.0.12 → aury_boot-0.0.14}/aury/boot/commands/templates/project/aury_docs/16-adapter.md.tpl

@@ -52,7 +52,7 @@ class PaymentAdapter(BaseAdapter):
     async def query_order(self, transaction_id: str) -> dict:
         """查询支付订单。"""
         response = await self.http_client.get(
-            f"https://api.payment.com/orders/{transaction_id}"
+            f"https://api.payment.com/orders/{{transaction_id}}"
         )
         return response.json()
 
@@ -98,10 +98,10 @@ settings = AdapterSettings()
 # 方式 2：代码显式配置
 settings = AdapterSettings(
     mode="mock",
-    method_modes={
+    method_modes={{
         "query_order": "real",  # query_order 使用真实调用
         "create_order": "mock", # create_order 使用 Mock
-    },
+    }},
     debug=True,
 )
 
@@ -131,7 +131,7 @@ class WechatAdapter(HttpAdapter):
     async def _prepare_headers(self, headers: dict | None) -> dict:
         """添加认证头。"""
         headers = await super()._prepare_headers(headers)
-        headers["Authorization"] = f"Bearer {await self._get_access_token()}"
+        headers["Authorization"] = f"Bearer {{await self._get_access_token()}}"
         return headers
 
     @adapter_method("send_message")
@@ -146,7 +146,7 @@ class WechatAdapter(HttpAdapter):
     @send_message.mock
     async def send_message_mock(self, openid: str, content: str) -> dict:
         """发送消息（Mock）。"""
-        return {"errcode": 0, "errmsg": "ok", "mock": True}
+        return {{"errcode": 0, "errmsg": "ok", "mock": True}}
 ```
 
 ## 16.5 方法级模式覆盖
@@ -272,7 +272,7 @@ class CompositePaymentAdapter(BaseAdapter):
         elif channel == "wechat":
             return await self.wechat.create_order(amount, order_id)
         else:
-            raise ValueError(f"不支持的支付渠道: {channel}")
+            raise ValueError(f"不支持的支付渠道: {{channel}}")
 
     @pay.mock
     async def pay_mock(self, channel: str, amount: int, order_id: str) -> dict:
@@ -350,7 +350,7 @@ THIRD_PARTY__DEBUG=true
 
 # 测试环境 (.env.testing)
 THIRD_PARTY__GATEWAY_MODE=mock
-THIRD_PARTY__METHOD_MODES={"query": "sandbox"}
+THIRD_PARTY__METHOD_MODES={{"query": "sandbox"}}
 
 # 生产环境 (.env.production)
 THIRD_PARTY__GATEWAY_MODE=real

{aury_boot-0.0.12 → aury_boot-0.0.14}/aury/boot/commands/templates/project/aury_docs/99-cli.md.tpl

@@ -104,14 +104,79 @@ aury pkg remove redis
 
 常用环境变量：
 
-| 变量 | 说明 | 默认值 |
-|------|------|--------|
-| `ADMIN__ENABLED` | 是否启用管理后台 | `false` |
-| `ADMIN__PATH` | 管理后台路径 | `/api/admin-console` |
-| `ADMIN__DATABASE_URL` | 管理后台同步数据库 URL（可覆盖自动推导） | - |
-| `ADMIN__AUTH_MODE` | 认证模式（basic/bearer/none/custom/jwt） | `basic` |
-| `ADMIN__AUTH_SECRET_KEY` | session 签名密钥（生产必配） | - |
-| `ADMIN__AUTH_BASIC_USERNAME` | basic 用户名 | - |
-| `ADMIN__AUTH_BASIC_PASSWORD` | basic 密码 | - |
-| `ADMIN__AUTH_BEARER_TOKENS` | bearer token 白名单 | `[]` |
-| `ADMIN__AUTH_BACKEND` | 自定义认证后端导入路径（module:attr） | - |
+|| 变量 | 说明 | 默认值 |
+||------|------|--------|
+|| `ADMIN__ENABLED` | 是否启用管理后台 | `false` |
+|| `ADMIN__PATH` | 管理后台路径 | `/api/admin-console` |
+|| `ADMIN__DATABASE_URL` | 管理后台同步数据库 URL（可覆盖自动推导） | - |
+|| `ADMIN__AUTH_MODE` | 认证模式（basic/bearer/none/custom/jwt） | `basic` |
+|| `ADMIN__AUTH_SECRET_KEY` | session 签名密钥（生产必配） | - |
+|| `ADMIN__AUTH_BASIC_USERNAME` | basic 用户名 | - |
+|| `ADMIN__AUTH_BASIC_PASSWORD` | basic 密码 | - |
+|| `ADMIN__AUTH_BEARER_TOKENS` | bearer token 白名单 | `[]` |
+|| `ADMIN__AUTH_BACKEND` | 自定义认证后端导入路径（module:attr） | - |
+
+## 注册 CLI 与扩展命令
+
+### 内置 `aury` 命令如何注册
+
+Aury Boot 安装后会自动注册一个全局命令 `aury`（见框架自身的 `pyproject.toml`）：
+
+```toml
+[project.scripts]
+aury = "aury.boot.commands:main"
+```
+
+- `aury.boot.commands:main` 是 Typer 应用入口，内部通过 `app.add_typer(...)` 注册了 `init/generate/server/scheduler/worker/migrate/docker/docs/pkg` 等子命令。
+
+### 在你自己的项目里注册一个 CLI
+
+如果你希望在自己的服务里有一个独立的 CLI（例如 `{project_name_snake}`），并且复用 Aury Boot 的全部基础命令，可以这样做：
+
+1. 新建模块 `{package_name}/cli.py`：
+
+```python
+from typer import Typer
+from aury.boot.commands import register_commands
+
+# 创建项目自己的 CLI
+app = Typer(name="{project_name_snake}")
+
+# 继承 aury-boot 的所有基础命令
+register_commands(app)
+
+# 或者按需关闭某些命令，例如不暴露 docker 命令：
+# register_commands(app, include_docker=False)
+
+
+# 添加你自己的项目命令
+@app.command()
+async def hello(name: str = "world") -> None:
+    """示例：项目自定义命令。"""
+    print(f"Hello, {name} from {project_name_snake}!")
+```
+
+> 注意：这里的 `app` 是 Typer 应用实例，`register_commands` 会把所有内置的 `init/generate/server/...` 等命令挂到你自己的 CLI 下。
+
+2. 在你项目自己的 `pyproject.toml` 中注册脚本入口（**不是框架本身的 pyproject**）：
+
+```toml
+[project.scripts]
+{project_name_snake} = "{package_name}.cli:app"
+```
+
+3. 安装项目后，你就可以使用：
+
+```bash
+# 使用项目 CLI 运行 aury-boot 命令
+{project_name_snake} init
+{project_name_snake} generate crud user -i
+{project_name_snake} server dev
+
+# 调用你自定义的命令
+{project_name_snake} hello --name dev
+```
+
+这样：
+- 基础命令仍由 Aury Boot 维护和升级；
+- 你的项目可以在自己的命名空间下扩展命令，而不用直接修改框架的 `aury` 命令。