vega-framework 0.1.18__tar.gz → 0.1.20__tar.gz

{vega_framework-0.1.18 → vega_framework-0.1.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vega-framework
-Version: 0.1.18
+Version: 0.1.20
 Summary: Enterprise-ready Python framework that enforces Clean Architecture for building maintainable and scalable applications.
 License: MIT
 License-File: LICENSE

{vega_framework-0.1.18 → vega_framework-0.1.20}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vega-framework"
-version = "0.1.18"
+version = "0.1.20"
 description = "Enterprise-ready Python framework that enforces Clean Architecture for building maintainable and scalable applications."
 authors = ["Roberto Ferro"]
 license = "MIT"

{vega_framework-0.1.18 → vega_framework-0.1.20}/vega/cli/commands/generate.py

@@ -424,10 +424,11 @@ def _generate_router(project_root: Path, project_name: str, name: str) -> None:
     routes_path = web_path / "routes"
     routes_path.mkdir(exist_ok=True)
 
-    # Check if __init__.py exists
+    # Check if __init__.py exists, create with auto-discovery if not
     init_file = routes_path / "__init__.py"
     if not init_file.exists():
-        init_file.write_text('"""API Routes"""\n')
+        from vega.cli.templates import render_fastapi_routes_init_autodiscovery
+        init_file.write_text(render_fastapi_routes_init_autodiscovery())
         click.echo(f"+ Created {click.style(str(init_file.relative_to(project_root)), fg='green')}")
 
     # Generate router file
@@ -442,14 +443,12 @@ def _generate_router(project_root: Path, project_name: str, name: str) -> None:
 
     click.echo(f"+ Created {click.style(str(router_file.relative_to(project_root)), fg='green')}")
 
-    # Register the router in routes/__init__.py
-    _register_router_in_init(project_root, resource_file, resource_name)
-
     # Instructions for next steps
     click.echo(f"\nNext steps:")
     click.echo(f"   1. Create Pydantic models in presentation/web/models/{resource_file}_models.py")
     click.echo(f"   2. Implement domain interactors for {resource_name} operations")
     click.echo(f"   3. Replace in-memory storage with actual use cases")
+    click.echo(click.style(f"   (Router auto-discovered from web/routes/)", fg='dim'))
 
 
 def _generate_middleware(project_root: Path, project_name: str, class_name: str, file_name: str) -> None:
@@ -688,11 +687,12 @@ def _generate_command(project_root: Path, project_name: str, name: str, is_async
     # Create commands directory if it doesn't exist
     commands_path = cli_path / "commands"
     commands_path.mkdir(exist_ok=True)
-    
-    # Check if __init__.py exists
+
+    # Check if __init__.py exists, create with auto-discovery if not
     init_file = commands_path / "__init__.py"
     if not init_file.exists():
-        init_file.write_text('"""CLI Commands"""\n')
+        from vega.cli.templates import render_cli_commands_init
+        init_file.write_text(render_cli_commands_init())
         click.echo(f"+ Created {click.style(str(init_file.relative_to(project_root)), fg='green')}")
     
     # Convert name to snake_case for command and file
@@ -803,8 +803,7 @@ def _generate_command(project_root: Path, project_name: str, name: str, is_async
     # Instructions for next steps
     click.echo(f"\nNext steps:")
     click.echo(f"   1. Implement your command logic in {command_file.relative_to(project_root)}")
-    click.echo(f"   2. Import and register in main.py:")
-    click.echo(click.style(f"      from presentation.cli.commands.{file_name} import {file_name}", fg='cyan'))
-    click.echo(click.style(f"      cli.add_command({file_name})", fg='cyan'))
+    click.echo(f"   2. Run your command: python main.py {command_name}")
+    click.echo(click.style(f"      (Commands are auto-discovered from cli/commands/)", fg='dim'))
     if with_interactor:
         click.echo(f"   3. Create interactor: vega generate interactor {interactor_name}")

{vega_framework-0.1.18 → vega_framework-0.1.20}/vega/cli/commands/init.py

@@ -47,7 +47,15 @@ def init_project(project_name: str, template: str, parent_path: str):
     for directory in directories:
         dir_path = project_path / directory
         dir_path.mkdir(parents=True, exist_ok=True)
-        (dir_path / "__init__.py").write_text("")
+
+        # Use auto-discovery template for cli/commands
+        if "cli" in directory and "commands" in directory:
+            from vega.cli.templates import render_cli_commands_init
+            content = render_cli_commands_init()
+            (dir_path / "__init__.py").write_text(content)
+        else:
+            (dir_path / "__init__.py").write_text("")
+
         click.echo(f"  + Created {directory}/")
 
     # Create __init__.py files

{vega_framework-0.1.18 → vega_framework-0.1.20}/vega/cli/scaffolds/fastapi.py

@@ -9,7 +9,7 @@ from vega.cli.templates import (
     render_fastapi_app,
     render_fastapi_health_route,
     render_fastapi_main,
-    render_fastapi_routes_init,
+    render_fastapi_routes_init_autodiscovery,
     render_fastapi_user_route,
     render_pydantic_models_init,
     render_pydantic_user_models,
@@ -37,7 +37,7 @@ def create_fastapi_scaffold(
         (web_dir / "__init__.py", render_web_package_init()),
         (web_dir / "app.py", render_fastapi_app(project_name)),
         (web_dir / "main.py", render_fastapi_main(project_name)),
-        (routes_dir / "__init__.py", render_fastapi_routes_init()),
+        (routes_dir / "__init__.py", render_fastapi_routes_init_autodiscovery()),
         (routes_dir / "health.py", render_fastapi_health_route()),
         (routes_dir / "users.py", render_fastapi_user_route()),
         (models_dir / "__init__.py", render_pydantic_models_init()),

{vega_framework-0.1.18 → vega_framework-0.1.20}/vega/cli/templates/__init__.py

@@ -26,6 +26,8 @@ from .components import (
     render_sqlalchemy_model,
     render_cli_command,
     render_cli_command_simple,
+    render_cli_commands_init,
+    render_fastapi_routes_init_autodiscovery,
 )
 from .loader import render_template
 
@@ -57,5 +59,7 @@ __all__ = [
     "render_sqlalchemy_model",
     "render_cli_command",
     "render_cli_command_simple",
+    "render_cli_commands_init",
+    "render_fastapi_routes_init_autodiscovery",
     "render_template",
 ]

{vega_framework-0.1.18 → vega_framework-0.1.20}/vega/cli/templates/cli/command.py.j2

@@ -33,8 +33,8 @@ async def {{ command_name }}({{ params_signature }}):
 
     # Your command implementation here
     click.echo("{{ command_name }} executed!")
-    {% if params_signature -%}
-    {% for param in params_list -%}
+{% if params_signature %}
+    {% for param in params_list %}
     click.echo(f"  {{ param }}: {{'{'}}{{ param }}{{'}'}}")
-    {% endfor -%}
-    {% endif %}
+    {% endfor %}
+{% endif %}

{vega_framework-0.1.18 → vega_framework-0.1.20}/vega/cli/templates/cli/command_simple.py.j2

@@ -12,8 +12,8 @@ import click
 def {{ command_name }}({{ params_signature }}):
     """{{ description }}"""
     click.echo("{{ command_name }} executed!")
-    {% if params_signature -%}
-    {% for param in params_list -%}
+{% if params_signature %}
+    {% for param in params_list %}
     click.echo(f"  {{ param }}: {{'{'}}{{ param }}{{'}'}}")
-    {% endfor -%}
-    {% endif %}
+    {% endfor %}
+{% endif %}

vega_framework-0.1.20/vega/cli/templates/cli/commands_init.py.j2

@@ -0,0 +1,12 @@
+"""Custom CLI commands auto-discovery"""
+from vega.discovery import discover_commands
+
+
+def get_commands():
+    """
+    Auto-discover Click commands in this directory.
+
+    Returns:
+        list: List of Click command objects found in this directory
+    """
+    return discover_commands(__package__)

{vega_framework-0.1.18 → vega_framework-0.1.20}/vega/cli/templates/components.py

@@ -237,3 +237,13 @@ def render_cli_command_simple(
         params_signature=params_signature,
         params_list=params_list,
     )
+
+
+def render_cli_commands_init() -> str:
+    """Return the template for cli/commands/__init__.py with auto-discovery"""
+    return render_template("commands_init.py.j2", subfolder="cli")
+
+
+def render_fastapi_routes_init_autodiscovery() -> str:
+    """Return the template for web/routes/__init__.py with auto-discovery"""
+    return render_template("routes_init_autodiscovery.py.j2", subfolder="web")

{vega_framework-0.1.18 → vega_framework-0.1.20}/vega/cli/templates/project/main.py.j2

@@ -35,7 +35,14 @@ def hello():
     click.echo("Add your CLI commands in presentation/cli/commands/")
 
 
-# Add more CLI commands here or import them from presentation/cli/commands/
+# Auto-register custom commands from presentation/cli/commands/
+try:
+    from presentation.cli.commands import get_commands
+    for cmd in get_commands():
+        cli.add_command(cmd)
+except ImportError:
+    # cli/commands/ not created yet
+    pass
 
 
 if __name__ == "__main__":
@@ -88,7 +95,14 @@ def greet(name: str):
 #     )
 
 
-# Add more CLI commands here or import them from presentation/cli/commands/
+# Auto-register custom commands from presentation/cli/commands/
+try:
+    from presentation.cli.commands import get_commands
+    for cmd in get_commands():
+        cli.add_command(cmd)
+except ImportError:
+    # cli/commands/ not created yet
+    pass
 
 
 if __name__ == "__main__":

{vega_framework-0.1.18 → vega_framework-0.1.20}/vega/cli/templates/project/main_fastapi.py.j2

@@ -62,7 +62,14 @@ async def create_user(name: str, email: str):
     click.echo("Note: Replace this with your actual CreateUser interactor")
 
 
-# Add more CLI commands here or import them from presentation/cli/commands/
+# Auto-register custom commands from presentation/cli/commands/
+try:
+    from presentation.cli.commands import get_commands
+    for cmd in get_commands():
+        cli.add_command(cmd)
+except ImportError:
+    # cli/commands/ not created yet
+    pass
 
 
 if __name__ == "__main__":

{vega_framework-0.1.18 → vega_framework-0.1.20}/vega/cli/templates/project/main_standard.py.j2

@@ -70,7 +70,14 @@ async def create_user(name: str, email: str):
 #     )
 
 
-# Add more CLI commands here or import them from presentation/cli/commands/
+# Auto-register custom commands from presentation/cli/commands/
+try:
+    from presentation.cli.commands import get_commands
+    for cmd in get_commands():
+        cli.add_command(cmd)
+except ImportError:
+    # cli/commands/ not created yet
+    pass
 
 
 if __name__ == "__main__":

vega_framework-0.1.20/vega/cli/templates/web/routes_init_autodiscovery.py.j2

@@ -0,0 +1,12 @@
+"""API routers auto-discovery"""
+from vega.discovery import discover_routers
+
+
+def get_api_router():
+    """
+    Auto-discover and register FastAPI routers in this directory.
+
+    Returns:
+        APIRouter: Main API router with all discovered routers included
+    """
+    return discover_routers(__package__)

vega_framework-0.1.20/vega/discovery/__init__.py

@@ -0,0 +1,5 @@
+"""Auto-discovery utilities for Vega framework"""
+from .routes import discover_routers
+from .commands import discover_commands
+
+__all__ = ["discover_routers", "discover_commands"]

vega_framework-0.1.20/vega/discovery/commands.py

@@ -0,0 +1,104 @@
+"""Click CLI commands auto-discovery utilities"""
+import importlib
+import inspect
+import logging
+from pathlib import Path
+from typing import List
+
+try:
+    import click
+except ImportError:
+    click = None
+
+logger = logging.getLogger(__name__)
+
+
+def discover_commands(
+    base_package: str,
+    commands_subpackage: str = "presentation.cli.commands"
+) -> List["click.Command"]:
+    """
+    Auto-discover Click commands from a package.
+
+    This function scans a package directory for Python modules containing
+    Click Command instances and returns them as a list.
+
+    Args:
+        base_package: Base package name (use __package__ from calling module)
+        commands_subpackage: Subpackage path containing commands (default: "presentation.cli.commands")
+
+    Returns:
+        List[click.Command]: List of discovered Click commands
+
+    Example:
+        # In your project's presentation/cli/commands/__init__.py
+        from vega.discovery import discover_commands
+
+        def get_commands():
+            return discover_commands(__package__)
+
+        # Or with custom configuration
+        def get_commands():
+            return discover_commands(
+                __package__,
+                commands_subpackage="cli.custom_commands"
+            )
+
+    Note:
+        Each command module can export multiple Click Command instances.
+        All public (non-underscore prefixed) Command instances will be discovered.
+    """
+    if click is None:
+        raise ImportError(
+            "Click is not installed. Install it with: pip install click"
+        )
+
+    commands = []
+
+    # Resolve the commands package path
+    try:
+        # Determine the package to scan
+        if base_package.endswith(commands_subpackage):
+            commands_package = base_package
+        else:
+            # Extract base from fully qualified package name
+            parts = base_package.split('.')
+            # Find the root package (usually the project name)
+            root_package = parts[0]
+            commands_package = f"{root_package}.{commands_subpackage}"
+
+        # Import the commands package to get its path
+        commands_module = importlib.import_module(commands_package)
+        commands_dir = Path(commands_module.__file__).parent
+
+        logger.debug(f"Discovering commands in: {commands_dir}")
+
+        # Scan for command modules
+        discovered_count = 0
+        for file in commands_dir.glob("*.py"):
+            if file.stem == "__init__":
+                continue
+
+            module_name = f"{commands_package}.{file.stem}"
+
+            try:
+                module = importlib.import_module(module_name)
+
+                # Find all Click Command instances
+                for name, obj in inspect.getmembers(module):
+                    if isinstance(obj, click.Command) and not name.startswith("_"):
+                        commands.append(obj)
+                        discovered_count += 1
+                        logger.info(f"Registered command: {name} from {module_name}")
+
+            except Exception as e:
+                logger.warning(f"Failed to import {module_name}: {e}")
+                continue
+
+        logger.info(f"Auto-discovery complete: {discovered_count} command(s) registered")
+
+    except ImportError as e:
+        logger.error(f"Failed to import commands package '{commands_package}': {e}")
+        raise
+
+    return commands

vega_framework-0.1.20/vega/discovery/routes.py

@@ -0,0 +1,129 @@
+"""FastAPI router auto-discovery utilities"""
+import importlib
+import inspect
+import logging
+from pathlib import Path
+from typing import Optional
+
+try:
+    from fastapi import APIRouter
+except ImportError:
+    APIRouter = None
+
+logger = logging.getLogger(__name__)
+
+
+def discover_routers(
+    base_package: str,
+    routes_subpackage: str = "presentation.web.routes",
+    api_prefix: str = "/api",
+    auto_tags: bool = True,
+    auto_prefix: bool = True
+) -> "APIRouter":
+    """
+    Auto-discover and register FastAPI routers from a package.
+
+    This function scans a package directory for Python modules containing
+    APIRouter instances named 'router' and automatically registers them
+    with the main router.
+
+    Args:
+        base_package: Base package name (use __package__ from calling module)
+        routes_subpackage: Subpackage path containing routes (default: "presentation.web.routes")
+        api_prefix: Prefix for the main API router (default: "/api")
+        auto_tags: Automatically generate tags from module name (default: True)
+        auto_prefix: Automatically generate prefix from module name (default: True)
+
+    Returns:
+        APIRouter: Main router with all discovered routers included
+
+    Example:
+        # In your project's presentation/web/routes/__init__.py
+        from vega.discovery import discover_routers
+
+        router = discover_routers(__package__)
+
+        # Or with custom configuration
+        router = discover_routers(
+            __package__,
+            routes_subpackage="api.routes",
+            api_prefix="/v1"
+        )
+
+    Note:
+        Each route module should export an APIRouter instance named 'router'.
+        The module filename will be used for tags and prefix generation if enabled.
+    """
+    if APIRouter is None:
+        raise ImportError(
+            "FastAPI is not installed. Install it with: pip install fastapi"
+        )
+
+    main_router = APIRouter(prefix=api_prefix)
+
+    # Resolve the routes package path
+    try:
+        # Determine the package to scan
+        if base_package.endswith(routes_subpackage):
+            routes_package = base_package
+        else:
+            # Extract base from fully qualified package name
+            parts = base_package.split('.')
+            # Find the root package (usually the project name)
+            root_package = parts[0]
+            routes_package = f"{root_package}.{routes_subpackage}"
+
+        # Import the routes package to get its path
+        routes_module = importlib.import_module(routes_package)
+        routes_dir = Path(routes_module.__file__).parent
+
+        logger.debug(f"Discovering routers in: {routes_dir}")
+
+        # Scan for router modules
+        discovered_count = 0
+        for file in routes_dir.glob("*.py"):
+            if file.stem == "__init__":
+                continue
+
+            module_name = f"{routes_package}.{file.stem}"
+
+            try:
+                module = importlib.import_module(module_name)
+
+                # Find APIRouter instance named 'router'
+                router = getattr(module, 'router', None)
+
+                if isinstance(router, APIRouter):
+                    # Generate tags and prefix from module name
+                    if auto_tags:
+                        tag = file.stem.replace("_", " ").title()
+                        tags = [tag]
+                    else:
+                        tags = None
+
+                    if auto_prefix:
+                        prefix = f"/{file.stem.replace('_', '-')}"
+                    else:
+                        prefix = None
+
+                    main_router.include_router(
+                        router,
+                        tags=tags,
+                        prefix=prefix
+                    )
+                    discovered_count += 1
+                    logger.info(f"Registered router: {module_name} (tags={tags}, prefix={prefix})")
+                else:
+                    logger.debug(f"No 'router' found in {module_name}")
+
+            except Exception as e:
+                logger.warning(f"Failed to import {module_name}: {e}")
+                continue
+
+        logger.info(f"Auto-discovery complete: {discovered_count} router(s) registered")
+
+    except ImportError as e:
+        logger.error(f"Failed to import routes package '{routes_package}': {e}")
+        raise
+
+    return main_router