toms-fast 0.2.1__py3-none-any.whl

tomskit/cli/__init__.py

@@ -0,0 +1,207 @@
+"""
+toms-fast CLI 工具
+"""
+
+import argparse
+import sys
+import tomllib
+from pathlib import Path
+from typing import Optional
+
+from .scaffold import create_project
+
+
+def init_migrations(project_path: Optional[Path] = None):
+    """为已存在的项目初始化数据库迁移"""
+    if project_path is None:
+        project_path = Path.cwd()
+    
+    project_path = Path(project_path).resolve()
+    
+    # 检查是否在 backend 目录或项目根目录
+    backend_path = project_path
+    project_root = project_path
+    if (project_path / "backend").exists():
+        # 在项目根目录，使用 backend 目录
+        backend_path = project_path / "backend"
+        project_root = project_path
+    elif not (project_path / "main.py").exists() and not (project_path / "app").exists():
+        print("❌ 错误: 未找到项目文件，请确保在项目根目录或 backend 目录运行此命令")
+        sys.exit(1)
+    else:
+        # 在 backend 目录，项目根目录是父目录
+        project_root = project_path.parent
+    
+    # 获取项目名称
+    project_name = project_root.name
+    
+    # 尝试从 pyproject.toml 读取项目名称
+    pyproject_path = backend_path / "pyproject.toml"
+    if pyproject_path.exists():
+        try:
+            with open(pyproject_path, "rb") as f:
+                pyproject_data = tomllib.load(f)
+                if "project" in pyproject_data and "name" in pyproject_data["project"]:
+                    project_name = pyproject_data["project"]["name"]
+        except Exception:
+            # 如果读取失败，使用目录名称
+            pass
+    
+    migrations_dir = backend_path / "migrations"
+    alembic_ini = migrations_dir / "alembic.ini"
+    
+    # 检查是否已经初始化
+    if migrations_dir.exists() and alembic_ini.exists():
+        print("⚠️  警告: migrations 目录和 alembic.ini 已存在")
+        response = input("是否重新初始化？这将覆盖现有配置 (y/N): ")
+        if response.lower() != 'y':
+            print("❌ 已取消")
+            return
+    
+    print(f"🚀 正在为{project_name}项目初始化数据库迁移...")
+    print(f"📁 后端路径: {backend_path}")
+    print(f"📦 项目名称: {project_name}")
+    
+    # 创建 migrations 目录结构
+    migrations_dir.mkdir(exist_ok=True)
+    versions_dir = migrations_dir / "versions"
+    versions_dir.mkdir(exist_ok=True)
+    
+    # 创建 __init__.py 文件
+    (migrations_dir / "__init__.py").write_text('"""\n数据库迁移目录\n"""\n', encoding="utf-8")
+    (versions_dir / "__init__.py").write_text('"""\n数据库迁移版本目录\n"""\n', encoding="utf-8")
+    
+    # 从模板创建配置文件
+    from .templates.migrations import get_migrations_templates
+    
+    templates = get_migrations_templates(project_name)
+    
+    # 创建 migrations/alembic.ini
+    if "alembic_ini" in templates:
+        alembic_content = templates["alembic_ini"]()
+        alembic_ini.write_text(alembic_content, encoding="utf-8")
+        print("  ✓ 创建文件: migrations/alembic.ini")
+    
+    # 创建 migrations/env.py
+    if "migrations_env_py" in templates:
+        env_content = templates["migrations_env_py"]()
+        (migrations_dir / "env.py").write_text(env_content, encoding="utf-8")
+        print(f"  ✓ 创建文件: migrations/env.py")
+    
+    # 创建 migrations/script.py.mako
+    if "migrations_script_py_mako" in templates:
+        script_content = templates["migrations_script_py_mako"]()
+        (migrations_dir / "script.py.mako").write_text(script_content, encoding="utf-8")
+        print(f"  ✓ 创建文件: migrations/script.py.mako")
+    
+    print("\n✅ 数据库迁移初始化成功！")
+    print("\n📝 下一步:")
+    print("   # 创建初始迁移:")
+    print("   uv run alembic -c migrations/alembic.ini revision --autogenerate -m 'Initial migration'")
+    print("   # 应用迁移到数据库:")
+    print("   uv run alembic -c migrations/alembic.ini upgrade head")
+
+
+def main():
+    """CLI 入口函数"""
+    parser = argparse.ArgumentParser(
+        description="toms-fast 项目脚手架生成器",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    
+    subparsers = parser.add_subparsers(dest="command", help="可用命令")
+    
+    # init 命令：创建新项目
+    init_parser = subparsers.add_parser("init", help="创建新项目")
+    init_parser.add_argument(
+        "project_name",
+        help="项目名称（将作为包名和目录名）"
+    )
+    init_parser.add_argument(
+        "-d", "--dir",
+        dest="target_dir",
+        help="目标目录（默认为当前目录）",
+        default=None
+    )
+    init_parser.add_argument(
+        "-t", "--type",
+        dest="project_type",
+        choices=["fastapi", "celery", "full"],
+        default="full",
+        help="项目类型：fastapi（仅 FastAPI）、celery（仅 Celery）、full（FastAPI + Celery，默认）"
+    )
+    
+    # migrations 命令：初始化数据库迁移
+    migrations_parser = subparsers.add_parser("migrations", help="为已存在的项目初始化数据库迁移")
+    migrations_parser.add_argument(
+        "-d", "--dir",
+        dest="project_dir",
+        help="项目目录（默认为当前目录）",
+        default=None
+    )
+    
+    args = parser.parse_args()
+    
+    # 如果没有指定命令，默认使用 init（向后兼容）
+    if args.command is None:
+        # 尝试解析为 init 命令的参数
+        if len(sys.argv) > 1 and not sys.argv[1].startswith('-'):
+            project_name = sys.argv[1]
+            # 解析其他参数
+            target_dir = None
+            project_type = "full"
+            
+            i = 2
+            while i < len(sys.argv):
+                if sys.argv[i] in ("-d", "--dir") and i + 1 < len(sys.argv):
+                    target_dir = sys.argv[i + 1]
+                    i += 2
+                elif sys.argv[i] in ("-t", "--type") and i + 1 < len(sys.argv):
+                    project_type = sys.argv[i + 1]
+                    i += 2
+                else:
+                    i += 1
+            
+            # 验证项目名称
+            if not project_name.replace("_", "").replace("-", "").isalnum():
+                print("❌ 错误: 项目名称只能包含字母、数字、下划线和连字符")
+                sys.exit(1)
+            
+            # 创建脚手架
+            try:
+                create_project(project_name, target_dir, project_type)
+            except Exception as e:
+                print(f"❌ 创建项目失败: {e}")
+                import traceback
+                traceback.print_exc()
+                sys.exit(1)
+        else:
+            parser.print_help()
+            sys.exit(1)
+    elif args.command == "init":
+        # 验证项目名称
+        if not args.project_name.replace("_", "").replace("-", "").isalnum():
+            print("❌ 错误: 项目名称只能包含字母、数字、下划线和连字符")
+            sys.exit(1)
+        
+        # 创建脚手架
+        try:
+            create_project(args.project_name, args.target_dir, args.project_type)
+        except Exception as e:
+            print(f"❌ 创建项目失败: {e}")
+            import traceback
+            traceback.print_exc()
+            sys.exit(1)
+    elif args.command == "migrations":
+        # 初始化 migrations
+        try:
+            init_migrations(args.project_dir)
+        except Exception as e:
+            print(f"❌ 初始化 migrations 失败: {e}")
+            import traceback
+            traceback.print_exc()
+            sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

tomskit/cli/__main__.py

@@ -0,0 +1,8 @@
+"""
+CLI 模块入口，支持 python -m tomskit.cli
+"""
+
+from . import main
+
+if __name__ == "__main__":
+    main()

tomskit/cli/scaffold.py

@@ -0,0 +1,123 @@
+"""
+项目脚手架生成器
+"""
+
+from pathlib import Path
+from typing import Optional
+
+from .templates_config import (
+    get_directory_structure,
+    get_file_templates,
+    get_template_functions,
+)
+
+
+class ProjectScaffold:
+    """项目脚手架生成器"""
+    
+    def __init__(self, project_name: str, target_dir: Optional[str] = None, project_type: str = "full"):
+        self.project_name = project_name
+        self.target_dir = Path(target_dir) if target_dir else Path.cwd() / project_name
+        self.project_path = self.target_dir / "backend"  # 代码放到 backend 目录
+        self.project_type = project_type
+        self.templates = get_template_functions(project_name, project_type)
+        
+    def create(self):
+        """创建项目结构"""
+        project_type_names = {
+            "fastapi": "FastAPI",
+            "celery": "Celery",
+            "full": "FastAPI + Celery"
+        }
+        print(f"🚀 正在创建项目: {self.project_name}")
+        print(f"📦 项目类型: {project_type_names.get(self.project_type, self.project_type)}")
+        print(f"📁 目标目录: {self.target_dir}")
+        
+        # 检查目录是否已存在
+        if self.target_dir.exists() and any(self.target_dir.iterdir()):
+            response = input(f"⚠️  目录 {self.target_dir} 已存在且不为空，是否继续？(y/N): ")
+            if response.lower() != 'y':
+                print("❌ 已取消")
+                return
+        
+        # 创建 web 目录（前端代码）
+        web_dir = self.target_dir / "web"
+        web_dir.mkdir(exist_ok=True)
+        print(f"  ✓ 创建目录: web/")
+        
+        # 创建目录结构
+        self._create_directories()
+        
+        # 创建文件（README 单独处理，放到项目根目录）
+        self._create_files()
+        
+        print("\n✅ 项目创建成功！")
+        print("\n📝 下一步:")
+        print(f"   cd {self.target_dir}/backend")
+        print("   uv sync  # 安装依赖（使用 uv 管理）")
+        print("   cp .env.example .env")
+        print("   # 编辑 .env 文件配置数据库和 Redis")
+        
+        if self.project_type in ("fastapi", "full"):
+            print("\n   # 数据库迁移:")
+            print("   # 1. 创建初始迁移:")
+            print("   uv run alembic -c migrations/alembic.ini revision --autogenerate -m 'Initial migration'")
+            print("   # 2. 应用迁移到数据库:")
+            print("   uv run alembic -c migrations/alembic.ini upgrade head")
+            print("\n   # 运行 FastAPI 应用:")
+            print("   uv run uvicorn main:app --reload")
+        if self.project_type in ("celery", "full"):
+            print("   # 运行 Celery Worker:")
+            print("   uv run celery -A celery_app worker --loglevel=info")
+        
+    def _create_directories(self):
+        """创建目录结构（从配置文件读取）"""
+        directory_structure = get_directory_structure(self.project_type)
+        for dir_path_str, need_init in directory_structure.items():
+            dir_path = self.project_path / dir_path_str
+            dir_path.mkdir(parents=True, exist_ok=True)
+            
+            # 如果需要，创建 __init__.py
+            if need_init:
+                (dir_path / "__init__.py").touch()
+                print(f"  ✓ 创建目录: {dir_path_str}/ (含 __init__.py)")
+            else:
+                print(f"  ✓ 创建目录: {dir_path_str}/")
+    
+    def _create_files(self):
+        """创建所有文件（从配置文件读取）"""
+        file_templates = get_file_templates(self.project_type)
+        for file_path_str, template_key in file_templates.items():
+            # README.md 放到项目根目录，其他文件放到 backend 目录
+            if file_path_str == "README.md":
+                template_func = self.templates.get(template_key)
+                if template_func is None:
+                    print(f"  ⚠️  警告: 模板 '{template_key}' 未找到，跳过文件: {file_path_str}")
+                    continue
+                content = template_func()
+                readme_path = self.target_dir / "README.md"
+                readme_path.write_text(content, encoding="utf-8")
+                print(f"  ✓ 创建文件: README.md")
+                continue
+            
+            # 获取模板内容
+            template_func = self.templates.get(template_key)
+            if template_func is None:
+                print(f"  ⚠️  警告: 模板 '{template_key}' 未找到，跳过文件: {file_path_str}")
+                continue
+            
+            content = template_func()
+            self._write_file(file_path_str, content)
+    
+    def _write_file(self, relative_path: str, content: str):
+        """写入文件"""
+        file_path = self.project_path / relative_path
+        file_path.parent.mkdir(parents=True, exist_ok=True)
+        file_path.write_text(content, encoding="utf-8")
+        print(f"  ✓ 创建文件: {relative_path}")
+
+
+def create_project(project_name: str, target_dir: Optional[str] = None, project_type: str = "full"):
+    """创建项目的便捷函数"""
+    scaffold = ProjectScaffold(project_name, target_dir, project_type)
+    scaffold.create()

tomskit/cli/templates/__init__.py

@@ -0,0 +1,42 @@
+"""
+模板模块聚合
+从各个子模块导入所有模板函数
+"""
+
+from typing import Callable
+
+from . import base, extensions, fastapi, celery, migrations
+
+
+def get_all_templates(project_name: str, project_type: str = "full") -> dict[str, Callable[[], str]]:
+    """
+    获取所有模板函数
+    
+    Args:
+        project_name: 项目名称
+        project_type: 项目类型 (fastapi, celery, full)
+        
+    Returns:
+        模板函数字典
+    """
+    templates = {}
+    
+    # 基础模板（所有类型都需要）
+    templates.update(base.get_base_templates(project_name, project_type))
+    
+    # 扩展模板（所有类型都需要）
+    templates.update(extensions.get_extension_templates(project_name, project_type))
+    
+    # FastAPI 模板
+    if project_type in ("fastapi", "full"):
+        templates.update(fastapi.get_fastapi_templates(project_name))
+    
+    # Celery 模板
+    if project_type in ("celery", "full"):
+        templates.update(celery.get_celery_templates(project_name))
+    
+    # 数据库迁移模板（FastAPI 和 full 类型需要）
+    if project_type in ("fastapi", "full"):
+        templates.update(migrations.get_migrations_templates(project_name))
+    
+    return templates