framework-m-core 0.4.2__py3-none-any.whl → 0.5.0__py3-none-any.whl

framework_m_core/cli/init.py

@@ -0,0 +1,137 @@
+"""Init CLI Command - Scaffold frontend from template.
+
+This module provides commands to initialize new components of Framework M.
+
+Architecture:
+- No global state - all paths passed explicitly
+- Template resources via importlib.resources (Python 3.9+)
+- Explicit error handling for file operations
+- User feedback with print statements
+
+Usage:
+    m init:frontend                      # Initialize in ./frontend
+    m init:frontend ../my-frontend       # Initialize in custom location
+"""
+
+from __future__ import annotations
+
+import shutil
+import subprocess
+from importlib.resources import files
+from pathlib import Path
+from typing import Annotated
+
+import cyclopts
+
+
+def _copy_template(source_template: Path, target: Path) -> None:
+    """Copy template directory to target location.
+
+    Args:
+        source_template: Source template directory
+        target: Target directory
+
+    Raises:
+        FileExistsError: If target already exists
+        RuntimeError: If copy fails
+    """
+    if target.exists():
+        msg = f"Target directory already exists: {target}"
+        raise FileExistsError(msg)
+
+    try:
+        shutil.copytree(source_template, target)
+        print(f"✓ Copied template to {target}")
+    except Exception as e:
+        msg = f"Failed to copy template: {e}"
+        raise RuntimeError(msg) from e
+
+
+def _install_dependencies(target: Path) -> None:
+    """Install pnpm dependencies in target directory.
+
+    Args:
+        target: Frontend directory
+
+    Raises:
+        RuntimeError: If pnpm install fails
+    """
+    print("\nInstalling dependencies with pnpm...")
+    try:
+        subprocess.run(
+            ["pnpm", "install"],
+            cwd=str(target),
+            check=True,
+        )
+        print("✓ Dependencies installed")
+    except subprocess.CalledProcessError as e:
+        msg = f"Failed to install dependencies: {e}"
+        raise RuntimeError(msg) from e
+
+
+def init_frontend_command(
+    target: Annotated[
+        Path | None,
+        cyclopts.Parameter(
+            name=["target"],
+            help="Target directory for frontend (default: ./frontend)",
+        ),
+    ] = None,
+) -> None:
+    """Initialize a new frontend from template.
+
+    This scaffolds the bundled Desk frontend template to a target directory
+    and installs dependencies. The template includes:
+    - React + TypeScript + Vite
+    - @framework-m/desk npm package integration
+    - Refine.dev setup with authProvider, dataProvider, liveProvider
+    - Tailwind CSS + shadcn/ui components
+
+    Examples:
+        m init:frontend                      # Initialize in ./frontend
+        m init:frontend ../my-frontend       # Custom location
+
+    Architecture Notes:
+        - Uses apps/studio/frontend as template source
+        - No global state - all paths explicit
+        - Validates target doesn't exist (prevents overwrites)
+        - Runs pnpm install automatically
+    """
+    # Default to ./frontend
+    if target is None:
+        target = Path("frontend")
+
+    # Resolve to absolute path
+    target = target.resolve()
+
+    # Find template source from framework_m package
+    try:
+        template_resource = files("framework_m") / "templates" / "frontend"
+        if not template_resource.is_dir():
+            msg = "Frontend template not found in framework_m package"
+            raise RuntimeError(msg)
+
+        # Convert to Path for file operations
+        template_source = Path(str(template_resource))
+    except Exception as e:
+        msg = f"Failed to locate template: {e}"
+        raise RuntimeError(msg) from e
+
+    print(f"Initializing frontend at {target}")
+    print(f"Template source: {template_source}")
+
+    # Copy template
+    _copy_template(template_source, target)
+
+    # Install dependencies
+    _install_dependencies(target)
+
+    print("\n✓ Frontend initialized successfully!")
+    print("\nNext steps:")
+    print(f"  cd {target}")
+    print("  pnpm dev")
+    print("\nOr start with:")
+    print("  m start --with-frontend")
+
+
+__all__ = ["init_frontend_command"]

framework_m_core/cli/main.py

@@ -2,6 +2,7 @@ import cyclopts
 
 from framework_m_core import __version__
 from framework_m_core.cli.config import config_set_command, config_show_command
+from framework_m_core.cli.init import init_frontend_command
 from framework_m_core.cli.plugin_loader import load_plugins
 from framework_m_core.cli.utility import info_command
 
@@ -18,6 +19,9 @@ app.command(info_command, name="info")
 app.command(config_show_command, name="config:show")
 app.command(config_set_command, name="config:set")
 
+# Init commands
+app.command(init_frontend_command, name="init:frontend")
+
 # Load plugins
 load_plugins(app)
 

framework_m_core/cli/plugin_loader.py

@@ -94,6 +94,11 @@ def register_plugins(app: cyclopts.App, plugins: list[EntryPoint]) -> None:
                 logger.warning(
                     f"Plugin '{ep.name}' is not a cyclopts App or callable, skipping"
                 )
+        except cyclopts.exceptions.CommandCollisionError:
+            # Command already registered (core takes precedence over plugins)
+            logger.debug(
+                f"CLI plugin '{ep.name}' skipped - command already registered by core"
+            )
         except Exception as e:
             logger.warning(
                 f"Failed to register CLI plugin '{ep.name}': {e}",

framework_m_core/domain/outbox.py

@@ -27,7 +27,7 @@ Example:
 from __future__ import annotations
 
 from datetime import UTC, datetime
-from enum import Enum
+from enum import StrEnum
 from typing import Any
 from uuid import UUID, uuid4
 
@@ -39,7 +39,7 @@ def _utc_now() -> datetime:
     return datetime.now(UTC)
 
 
-class OutboxStatus(str, Enum):
+class OutboxStatus(StrEnum):
     """Status of an outbox entry.
 
     Attributes:

framework_m_core/pii.py

@@ -23,7 +23,7 @@ Example:
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 from typing import Any
 
 from pydantic import BaseModel, Field
@@ -35,7 +35,7 @@ from framework_m_core.config import load_config
 # =============================================================================
 
 
-class AuthMode(str, Enum):
+class AuthMode(StrEnum):
     """Available authentication modes.
 
     Attributes:
@@ -142,7 +142,7 @@ def is_sensitive_pii(field_name: str) -> bool:
 # =============================================================================
 
 
-class DeletionMode(str, Enum):
+class DeletionMode(StrEnum):
     """How to handle user data on account deletion.
 
     Attributes:

{framework_m_core-0.4.2.dist-info → framework_m_core-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: framework-m-core
-Version: 0.4.2
+Version: 0.5.0
 Summary: Core protocols and dependency injection for Framework M
 Author: Framework M Contributors
 License: MIT

{framework_m_core-0.4.2.dist-info → framework_m_core-0.5.0.dist-info}/RECORD

@@ -5,7 +5,7 @@ framework_m_core/decorators.py,sha256=UFY1HbiSLVmjKO8Ov7C6jdfMq7ND5OgwHb8WfIHiwT
 framework_m_core/exceptions.py,sha256=BwFviTUBB4FW2_fzDWYB5eAYzf0z1GVVX-vjcU4Fi78,4098
 framework_m_core/permission_lookup.py,sha256=dhJHiazQQ8SvC_MYizmFfwKgrTgT5g0qxa4Vq9thk8Q,6370
 framework_m_core/permissions.py,sha256=e7RRA1xbIO1WfFPEiTO4lDmvxkhW29QBisHPYqbzbt0,7177
-framework_m_core/pii.py,sha256=uIO3Mbrw9OGK9RLjTUsi6jJ-W_YpvPlWUT6N4Zsq2K4,5885
+framework_m_core/pii.py,sha256=lu3dk52SAS0TLAEDnLgiWbvHIzZtceidv5-SOVh-Z6A,5884
 framework_m_core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 framework_m_core/registry.py,sha256=FHgzaczGQjxIQU2JosnKppDyl3DB6ud09Ukgx-6GTVA,10279
 framework_m_core/rls.py,sha256=iBKGiWepYGW3CrObJeRjSra6Xv7xODRjEF6J--2NhsU,6158
@@ -15,8 +15,9 @@ framework_m_core/system_context.py,sha256=Axf5zixlBc81BcXLUuiiUBH2YzuRJ8BHj2CX2y
 framework_m_core/unit_of_work.py,sha256=FtOtsW0IKuxelyb_h2Hjszhr6ZWwQLIoVI4ZJle3bv4,4158
 framework_m_core/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 framework_m_core/cli/config.py,sha256=iePjU1xcsMSvK5M6QpO_FpossOOetRb9NdaK4T4ym2Y,3457
-framework_m_core/cli/main.py,sha256=hyavgEmTZ8_YcubPppFkr_BN7bf6Ai1FhF3iMYmYdHo,636
-framework_m_core/cli/plugin_loader.py,sha256=KqDI-vR-vhb5v61_rJxT7-6Z0-TuYbtxZqUO-Fj8d7M,3947
+framework_m_core/cli/init.py,sha256=Ru6DIeMW42akVnkV70Q6HWd9jp6M8UbrvO1gCLpGawg,4022
+framework_m_core/cli/main.py,sha256=5J7BTrFZSgUfHtbOhnXS8aKqZ6B0jkicZ5U8ZP5pOeY,770
+framework_m_core/cli/plugin_loader.py,sha256=-ITJk3DVyRjUl1PwNcjXNk6padDfM6dxmalRb4mf4b4,4210
 framework_m_core/cli/utility.py,sha256=CHPIs5_yfKb-xLL-H2NKM_FOQkFSVTlZGBL1C1njgYU,1275
 framework_m_core/doctypes/__init__.py,sha256=vC7opN27HoEKiRDuPwN-tq-dXwG3retVoDKeBlbiTrg,1847
 framework_m_core/doctypes/activity_log.py,sha256=_5XYRqe0NC98u1_9aWpZk1DdjHaTNPKp-Qb02_aE8pI,3564
@@ -49,7 +50,7 @@ framework_m_core/domain/base_controller.py,sha256=fXBMtogBxI-Igw8ntXH2iBe-OUFM1Y
 framework_m_core/domain/base_doctype.py,sha256=NShhuo_4rLruFLG4NL26swZ-bd3P-f4EIO2K5CLeaWc,9258
 framework_m_core/domain/mixins.py,sha256=Yk8fwYWyq9MJp_uU_r5jxf1nj2q5lYN3i1Ip_1ORFe8,3596
 framework_m_core/domain/naming_counter.py,sha256=UWQeOSeGqFHCFc-XqxWnudCsZHgSM43f5u93lvj3HSY,1626
-framework_m_core/domain/outbox.py,sha256=omso-0AJjSlxxyPy3TuPIOWRDLyHs_G2qMeEu9vgZMk,2778
+framework_m_core/domain/outbox.py,sha256=s39lpeTIni3Olr9K28a1PhEb19V6Qvj6WxfF5Td_DK0,2779
 framework_m_core/events/__init__.py,sha256=3qB9L7DjPTArt6OQnehsGXLJbLJ91DpWPMdsMsvtBS8,2760
 framework_m_core/interfaces/__init__.py,sha256=mfYjbV4Iwc2l_iaj2iVf2AbElc9LO-3a9WIqCBRXLaE,672
 framework_m_core/interfaces/audit.py,sha256=tRD63O6vCjOHt4R3XtBsQM-BeCjIjATSqDP5O1-plP8,6740
@@ -82,6 +83,6 @@ framework_m_core/interfaces/workflow.py,sha256=C1LDohdvmWF9P_PMq0FVHySHb2URHzxAO
 framework_m_core/services/__init__.py,sha256=xcv_UWRyhBSt70yJBVBEyrtRSpaINj-JC1Rs8KIpnUw,351
 framework_m_core/services/user_manager.py,sha256=PYI0URoVOc0cU4bQUlrIT1nK1VTwy2ThsvChhDeJ2Ss,5696
 framework_m_core/types/job_context.py,sha256=9Xhqidj--eiJZNASENRsQi_qZkFj-Nsy_-fDj1uMP9E,2766
-framework_m_core-0.4.2.dist-info/METADATA,sha256=lah3OjeIYm8JmRip9wAYvWnSHVCwPdHcUvYwCNPo0vg,2663
-framework_m_core-0.4.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-framework_m_core-0.4.2.dist-info/RECORD,,
+framework_m_core-0.5.0.dist-info/METADATA,sha256=y6_og0PoEMz5hxI1vFomNLFwpxr1Qs8ASIEhTI66V-8,2663
+framework_m_core-0.5.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+framework_m_core-0.5.0.dist-info/RECORD,,