vega-framework 0.1.15__py3-none-any.whl → 0.1.17__py3-none-any.whl

vega/cli/templates/project/README.md.j2

@@ -20,15 +20,11 @@ Vega Framework application with Clean Architecture.
 │   └── services/        # Service implementations
 │
 ├── presentation/        # Delivery mechanisms
-{% if template == "fastapi" -%}
-│   ├── web/            # FastAPI web interface
+│   ├── web/            # FastAPI web interface (if added)
 │   │   ├── routes/     # HTTP endpoints
 │   │   ├── app.py      # FastAPI app factory
 │   │   └── main.py     # ASGI entrypoint
-│   └── cli/            # CLI commands (if needed)
-{% else -%}
 │   └── cli/            # CLI commands
-{% endif -%}
 │
 ├── config.py            # Dependency injection setup
 ├── settings.py          # Application configuration
@@ -45,25 +41,148 @@ poetry install
 cp .env.example .env
 # Edit .env with your configuration
 
-# Generate components
-vega generate entity User
-vega generate repository UserRepository
-vega generate interactor CreateUser
+# Run CLI commands
+python main.py hello
+python main.py greet --name John
+
+# If using FastAPI template, run the web server
+python main.py web
+python main.py web --reload  # With auto-reload
+# Visit http://localhost:8000/api/health/status
 
 # Run tests
 poetry run pytest
 ```
 
+## Development with Vega CLI
+
+### Generate Components
+
+Generate Clean Architecture components quickly:
+
+```bash
+# Domain layer
+vega generate entity Product
+vega generate repository ProductRepository --impl memory
+vega generate service EmailService
+vega generate interactor CreateProduct
+
+# Application layer
+vega generate mediator CheckoutFlow
+
+# Presentation layer (web)
+vega generate router Product
+vega generate middleware Logging
+
+# Presentation layer (CLI)
+vega generate command CreateUser
+vega generate command ListUsers --impl sync
+```
+
+### Add Features
+
+Add FastAPI web support to your project:
+
+```bash
+vega add web
+```
+
+### Add Database Support
+
+Add SQLAlchemy and Alembic for database management:
+
+```bash
+vega add sqlalchemy  # or: vega add db
+```
+
+Then manage your database:
+
+```bash
+# Initialize database
+vega migrate init
+
+# Create migrations
+vega migrate create -m "Add users table"
+
+# Apply migrations
+vega migrate upgrade
+
+# Rollback migrations
+vega migrate downgrade
+```
+
+### Generate Database Models
+
+After adding SQLAlchemy support:
+
+```bash
+vega generate model User
+vega generate model Product
+```
+
+## Using Async Commands
+
+Vega Framework supports async/await in CLI commands, allowing you to execute interactors seamlessly:
+
+```python
+import click
+from vega.cli.utils import async_command
+
+@click.command()
+@click.option('--name', required=True)
+@async_command
+async def create_user(name: str):
+    """Create a user using an interactor"""
+    import config  # Initialize DI container
+    from domain.interactors.create_user import CreateUser
+
+    user = await CreateUser(name=name)
+    click.echo(f"Created: {user.name}")
+```
+
+This allows the same async business logic to work in both CLI and web contexts (FastAPI).
+
+## Project Commands Quick Reference
+
+```bash
+# Component generation
+vega generate entity <Name>
+vega generate repository <Name> [--impl memory|sql]
+vega generate interactor <Name>
+vega generate mediator <Name>
+vega generate command <Name> [--impl sync]
+
+# Feature management
+vega add web
+vega add sqlalchemy
+
+# Database management (requires SQLAlchemy)
+vega migrate init
+vega migrate create -m "message"
+vega migrate upgrade
+vega migrate downgrade
+
+# Project validation
+vega doctor
+
+# Framework updates
+vega update
+vega update --check
+```
+
 ## Vega Framework
 
-This project uses [Vega Framework](https://github.com/your-org/vega-framework) for Clean Architecture:
+This project uses [Vega Framework](https://github.com/robertosixty1/vega-framework) for Clean Architecture:
 
-- Automatic Dependency Injection
-- Clean Architecture patterns (4 layers: Domain, Application, Infrastructure, Presentation)
-- Type-safe with Python type hints
-- Easy to test and maintain
+- ✅ Automatic Dependency Injection
+- ✅ Clean Architecture patterns (4 layers: Domain, Application, Infrastructure, Presentation)
+- ✅ Type-safe with Python type hints
+- ✅ Async/await support for CLI and web
+- ✅ Easy to test and maintain
+- ✅ Framework-agnostic business logic
 
 ## Documentation
 
 - [Vega Framework Docs](https://vega-framework.readthedocs.io/)
 - [Clean Architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html)
+- [Vega CLI Reference](https://github.com/robertosixty1/vega-framework#cli-commands)

vega/cli/templates/project/config.py.j2

@@ -10,6 +10,8 @@ from vega.di import Container, set_container
 # from {{ project_name }}.infrastructure.repositories.memory_user_repository import MemoryUserRepository
 
 # Uncomment and configure database manager if using SQLAlchemy
+
+# from settings import settings
 # from infrastructure.database_manager import DatabaseManager
 # db_manager = DatabaseManager(url=settings.database_url)
 

vega/cli/templates/project/main_fastapi.py.j2

@@ -1,7 +1,11 @@
 """Main entry point for {{ project_name }}"""
 import click
+from vega.cli.utils import async_command
 import config  # noqa: F401 - Import to initialize DI container
 
+# Import your use cases here
+# from domain.interactors.create_user import CreateUser
+
 
 @click.group()
 def cli():
@@ -34,6 +38,30 @@ def hello():
     click.echo("Add your CLI commands in presentation/cli/commands/")
 
 
+@cli.command()
+@click.option('--name', required=True, help='User name')
+@click.option('--email', required=True, help='User email')
+@async_command
+async def create_user(name: str, email: str):
+    """
+    Example async CLI command that uses an interactor.
+
+    This demonstrates how to use async/await with Click commands
+    to execute interactors and other async operations.
+
+    Usage:
+        python main.py create-user --name="John Doe" --email="john@example.com"
+    """
+    # Import your interactor
+    # from domain.interactors.create_user import CreateUser
+    # user = await CreateUser(name=name, email=email)
+    # click.echo(f"Created user: {user.id} - {user.name}")
+
+    # Placeholder implementation
+    click.echo(f"Creating user: {name} ({email})")
+    click.echo("Note: Replace this with your actual CreateUser interactor")
+
+
 # Add more CLI commands here or import them from presentation/cli/commands/
 
 

vega/cli/templates/project/main_standard.py.j2

@@ -1,6 +1,6 @@
 """Main entry point for {{ project_name }}"""
-import asyncio
 import click
+from vega.cli.utils import async_command
 import config  # noqa: F401 - Import to initialize DI container
 
 # Import your use cases here
@@ -27,6 +27,30 @@ def greet(name: str):
     click.echo(f"Hello, {name}!")
 
 
+@cli.command()
+@click.option('--name', required=True, help='User name')
+@click.option('--email', required=True, help='User email')
+@async_command
+async def create_user(name: str, email: str):
+    """
+    Example async command that uses an interactor.
+
+    This demonstrates how to use async/await with Click commands
+    to execute interactors and other async operations.
+
+    Usage:
+        python main.py create-user --name="John Doe" --email="john@example.com"
+    """
+    # Import your interactor
+    # from domain.interactors.create_user import CreateUser
+    # user = await CreateUser(name=name, email=email)
+    # click.echo(f"Created user: {user.id} - {user.name}")
+
+    # Placeholder implementation
+    click.echo(f"Creating user: {name} ({email})")
+    click.echo("Note: Replace this with your actual CreateUser interactor")
+
+
 # Uncomment this block if you enable FastAPI support
 # @cli.command()
 # @click.option('--host', default='0.0.0.0', help='Host to bind')

vega/cli/utils/__init__.py

@@ -2,10 +2,13 @@
 from .naming import NamingConverter
 from .messages import CLIMessages
 from .validators import validate_project_name, validate_path_exists
+from .async_support import async_command, coro
 
 __all__ = [
     "NamingConverter",
     "CLIMessages",
     "validate_project_name",
     "validate_path_exists",
+    "async_command",
+    "coro",
 ]

vega/cli/utils/async_support.py

@@ -0,0 +1,55 @@
+"""Async support utilities for Click CLI commands"""
+import asyncio
+import functools
+from typing import TypeVar, Callable, Any
+
+import click
+
+F = TypeVar('F', bound=Callable[..., Any])
+
+
+def async_command(f: F) -> F:
+    """
+    Decorator to make Click commands support async functions.
+
+    This allows you to define async Click commands that can call
+    async interactors and other async operations.
+
+    Example:
+        @click.command()
+        @click.option('--name', required=True)
+        @async_command
+        async def create_user(name: str):
+            # Import config to initialize DI container
+            import config  # noqa: F401
+            from domain.interactors.create_user import CreateUser
+
+            user = await CreateUser(name=name)
+            click.echo(f"Created user: {user.name}")
+
+    Usage in Click groups:
+        @cli.command()
+        @click.argument('user_id')
+        @async_command
+        async def get_user(user_id: str):
+            user = await GetUser(user_id=user_id)
+            click.echo(f"User: {user.name}")
+    """
+    @functools.wraps(f)
+    def wrapper(*args: Any, **kwargs: Any) -> Any:
+        return asyncio.run(f(*args, **kwargs))
+    return wrapper  # type: ignore
+
+
+def coro(f: F) -> F:
+    """
+    Alias for async_command. Shorter name for convenience.
+
+    Example:
+        @click.command()
+        @coro
+        async def my_command():
+            result = await MyInteractor()
+            click.echo(result)
+    """
+    return async_command(f)