framework-m-core 0.4.1__tar.gz

framework_m_core-0.4.1/.gitignore

@@ -0,0 +1,119 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+.history/
+# static/ - removed generic ignore, specific ignores added below
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+env/
+
+# UV
+.uv/
+uv.lock
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+coverage.xml
+
+# Type checking
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Ruff
+.ruff_cache/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log
+
+# Local config
+.env
+.env.local
+
+# Docker
+docker-compose.override.yml
+
+# SQLite databases
+*.db
+*.sqlite
+*.sqlite3
+
+# Studio UI built assets
+apps/studio/src/framework_m_studio/static/
+
+#doctypes
+doctypes/*.py
+apps/studio/src/doctypes/*.py
+
+# Node.js / Frontend
+node_modules/
+.pnpm-store/
+*.tsbuildinfo
+
+# Frontend build outputs
+frontend/dist/
+frontend/.vite/
+apps/*/studio_ui/dist/
+apps/*/studio_ui/.vite/
+frontend/playwright-report
+frontend/test-results
+apps/studio/studio_ui/node_modules/
+
+# Logs
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Editor directories
+.idea/
+*.sublime-project
+*.sublime-workspace
+
+# Generated Documentation
+docs/developer/generated/
+docs/machine/
+
+# Website
+website/.docusaurus/
+website/build/
+website/node_modules/
+
+# GitLab Pages
+public/

framework_m_core-0.4.1/CHANGELOG.md

@@ -0,0 +1,105 @@
+# Changelog
+
+## framework-m-core v0.4.1
+
+### Bug Fixes
+
+- add both OIDC tokens to all publish jobs (206d05d)
+
+
+## framework-m-core v0.4.0
+
+### Features
+
+- add comprehensive README with installation and usage docs (9ce1589)
+- add comprehensive README with installation and usage docs (8a01633)
+
+### Bug Fixes
+
+- add pipeline status badge to README (c413751)
+- update package description in README (56a047c)
+- use correct pyproject-build executable from build package (45d68b6)
+
+
+## framework-m-core v0.3.1
+
+### Bug Fixes
+
+- add time import in release_utils (d4e3f8f)
+- use uv tool run instead of uv run for both build and twine (801aa3f)
+
+
+## framework-m-core v0.3.0
+
+### Features
+
+- Add new protocol-based interfaces, framework-mx-mongo and documentation generation (51f92ee)
+- add gitlint for conventional commit enforcement (5ec959f)
+- switch to scoped tags and fix release automation (e975051)
+- add unique constraint support and refine docs (5f9af98)
+- add Python-based release automation with update-existing-branch logic (6fcd9cb)
+- add automated release workflow with duplicate prevention (ca5a508)
+- add PyPI publishing for framework-m-studio and update docs (d6ed80a)
+- comprehensive documentation covering fundamentals, migration guides, i18n, multi-tenancy usage, and API references (6a2c1df)
+- implement Frontend Build & Serving (9f9aa79)
+- implement desk ui (13ebcc8)
+- implement workflows and advanced features (22a7745)
+- implement system doctypes and features (05e7f3d)
+- implement built-in doctypes and system adapters (23195d1)
+- cli tools implementation (18a1d83)
+- implement events, webhooks, monitoring and websockets (9381d3f)
+- add NATS event bus, cron scheduler, and document lifecycle events (1b6525a)
+- phase-03 complete (00123da)
+- prepare for package split after completion (e8abae2)
+- permission system implemented (632afb7)
+- litestar application setup and authentication middleware (7854664)
+- Complete DocType Engine & Database Layer (523f211)
+- refactor phase-01 and implemented doctype-engine with CRUD, migrations and cli (3c36234)
+- complete Phase 01 - Core Kernel & Interfaces (1dcbfab)
+- automated pipeline for gitlab registry (c1a9e2b)
+
+### Bug Fixes
+
+- release script and broken anchors in features.md (3830267)
+- broken links (dc03f4b)
+- footer links and broken markdown links (82d0595)
+- node version mismatch (7fc3067)
+- docs command to use colon instead of space (eddf12d)
+- lint and mypy errors (0e65b7d)
+- lint and mypy errors (0738180)
+- Resolve import errors and test failures after package split (6153884)
+- add pypi and pipeline badges to readme (62590fc)
+- robust package detection and safe MR title truncation (36385b6)
+- improve changelog extraction for GitLab release pages (bb636b0)
+- use show-ref for robust tag check and clear local ghost tags (79563c5)
+- finalize air-tight release automation with GitLab releases, professional logging, and zero-spam logic (0dc7b19)
+- simplify release rules and regex to stop recursive loops (790b318)
+- fix auto-tagging trigger and regex for merge commits (5e69fb9)
+- improve commit filtering and fix linting (6e4082d)
+- prevent duplicate changelog entries by ensuring tags are fetched and handled correctly (a498f85)
+- make release tag parsing more robust for large monorepos (8e1b5d8)
+- update project URLs to GitLab and refactor versioning source of truth (84e0bd3)
+- prevent recursive release loops and cleanup dead code (6ff3776)
+- remove create-studio-release-mr and detached HEAD (d814206)
+- lint issues (0c1dc94)
+- studio issues and ci pipeline (e17e9c2)
+- ruff issue (24fb2ef)
+- ruff issue (2b3dfb0)
+- mypy issues (23c539b)
+- Fix ruff linting errors (ad8997c)
+- lint format (8fc33e8)
+- add framework-m-studio in dev dependencies (3d3825a)
+- correct mypy type ignore for aioboto3 imports (aa04e86)
+- format with ruff (c9d5f39)
+- mypy issues (5ab1715)
+- format all files with ruff (90e3808)
+- remove skip ci from release commit message (2db2b6f)
+- correct directory navigation in release-package job (5b67a98)
+- lint error in base_doctype (47e8c37)
+- lint error in test_base_doctype (354f66f)
+- use twine for GitLab registry publishing (6472dc7)
+- specify dist path for uv publish (86df5c7)
+- exclude cache directories from source (695d2fb)
+- lint errors in tests (8b4120d)
+- rename workspace to avoid package name conflict (20e46bb)
+

framework_m_core-0.4.1/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: framework-m-core
+Version: 0.4.1
+Summary: Core protocols and dependency injection for Framework M
+Author: Framework M Contributors
+License: MIT
+Requires-Python: >=3.12
+Requires-Dist: argon2-cffi>=23.1.0
+Requires-Dist: cyclopts>=3.0.0
+Requires-Dist: dependency-injector>=4.41.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Description-Content-Type: text/markdown
+
+# Framework M Core
+
+[![PyPI version](https://badge.fury.io/py/framework-m-core.svg)](https://badge.fury.io/py/framework-m-core)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![GitLab Pipeline Status](https://gitlab.com/castlecraft/framework-m/badges/main/pipeline.svg)](https://gitlab.com/castlecraft/framework-m/-/pipelines)
+
+Core protocols and dependency injection container for Framework M.
+
+## Installation
+
+```bash
+pip install framework-m-core
+```
+
+Or with `uv`:
+
+```bash
+uv add framework-m-core
+```
+
+## What's Included
+
+### Protocol Interfaces (Ports)
+
+Framework M Core defines the protocol interfaces that adapters must implement:
+
+| Protocol | Purpose |
+|----------|---------|
+| `RepositoryProtocol` | CRUD operations for documents |
+| `EventBusProtocol` | Publish/subscribe events |
+| `PermissionProtocol` | Authorization with RLS |
+| `StorageProtocol` | File storage abstraction |
+| `JobQueueProtocol` | Background job processing |
+| `CacheProtocol` | Caching layer |
+| `NotificationProtocol` | Email/SMS notifications |
+| `SearchProtocol` | Full-text search |
+| `PrintProtocol` | PDF generation |
+| `I18nProtocol` | Internationalization |
+
+### Domain Base Classes
+
+- `BaseDocType` - Base class for all document types
+- `BaseController` - Lifecycle hooks (validate, before_save, after_save, etc.)
+- `SubmittableMixin` - For documents with submit/cancel workflow
+
+### Dependency Injection
+
+Built on `dependency-injector` for clean, testable code:
+
+```python
+from framework_m_core.container import Container
+
+container = Container()
+container.wire(modules=["my_app.services"])
+```
+
+### CLI Framework
+
+Built on `cyclopts` for powerful command-line interfaces:
+
+```python
+from framework_m_core.cli import app
+
+@app.command
+def my_command():
+    """My custom command."""
+    pass
+```
+
+## Usage
+
+This package is typically used as a dependency of `framework-m` or `framework-m-standard`. 
+For most applications, install the full `framework-m` package instead.
+
+## License
+
+MIT License - see [LICENSE](https://gitlab.com/castlecraft/framework-m/blob/main/LICENSE) for details.

framework_m_core-0.4.1/README.md

@@ -0,0 +1,78 @@
+# Framework M Core
+
+[![PyPI version](https://badge.fury.io/py/framework-m-core.svg)](https://badge.fury.io/py/framework-m-core)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![GitLab Pipeline Status](https://gitlab.com/castlecraft/framework-m/badges/main/pipeline.svg)](https://gitlab.com/castlecraft/framework-m/-/pipelines)
+
+Core protocols and dependency injection container for Framework M.
+
+## Installation
+
+```bash
+pip install framework-m-core
+```
+
+Or with `uv`:
+
+```bash
+uv add framework-m-core
+```
+
+## What's Included
+
+### Protocol Interfaces (Ports)
+
+Framework M Core defines the protocol interfaces that adapters must implement:
+
+| Protocol | Purpose |
+|----------|---------|
+| `RepositoryProtocol` | CRUD operations for documents |
+| `EventBusProtocol` | Publish/subscribe events |
+| `PermissionProtocol` | Authorization with RLS |
+| `StorageProtocol` | File storage abstraction |
+| `JobQueueProtocol` | Background job processing |
+| `CacheProtocol` | Caching layer |
+| `NotificationProtocol` | Email/SMS notifications |
+| `SearchProtocol` | Full-text search |
+| `PrintProtocol` | PDF generation |
+| `I18nProtocol` | Internationalization |
+
+### Domain Base Classes
+
+- `BaseDocType` - Base class for all document types
+- `BaseController` - Lifecycle hooks (validate, before_save, after_save, etc.)
+- `SubmittableMixin` - For documents with submit/cancel workflow
+
+### Dependency Injection
+
+Built on `dependency-injector` for clean, testable code:
+
+```python
+from framework_m_core.container import Container
+
+container = Container()
+container.wire(modules=["my_app.services"])
+```
+
+### CLI Framework
+
+Built on `cyclopts` for powerful command-line interfaces:
+
+```python
+from framework_m_core.cli import app
+
+@app.command
+def my_command():
+    """My custom command."""
+    pass
+```
+
+## Usage
+
+This package is typically used as a dependency of `framework-m` or `framework-m-standard`. 
+For most applications, install the full `framework-m` package instead.
+
+## License
+
+MIT License - see [LICENSE](https://gitlab.com/castlecraft/framework-m/blob/main/LICENSE) for details.

framework_m_core-0.4.1/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "framework-m-core"
+version = "0.4.1"
+description = "Core protocols and dependency injection for Framework M"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.12"
+authors = [
+    { name = "Framework M Contributors" }
+]
+dependencies = [
+    "pydantic>=2.0.0",
+    "pydantic-settings>=2.0.0",
+    "dependency-injector>=4.41.0",
+    "argon2-cffi>=23.1.0",
+    "cyclopts>=3.0.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/framework_m_core"]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+warn_return_any = true
+warn_unused_ignores = true
+disallow_untyped_defs = true

framework_m_core-0.4.1/src/framework_m_core/__init__.py

@@ -0,0 +1,29 @@
+"""Core module - Domain logic and interfaces."""
+
+import importlib.metadata
+
+from framework_m_core.container import Container
+from framework_m_core.domain.base_doctype import BaseDocType as DocType
+from framework_m_core.domain.base_doctype import Field
+from framework_m_core.interfaces.base_doctype import BaseDocTypeProtocol
+from framework_m_core.interfaces.bootstrap import BootstrapProtocol
+from framework_m_core.interfaces.controller import BaseControllerProtocol
+from framework_m_core.interfaces.schema_mapper import SchemaMapperProtocol
+from framework_m_core.registry import MetaRegistry
+
+try:
+    __version__ = importlib.metadata.version("framework-m-core")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "0.0.0"
+
+__all__ = [
+    "BaseControllerProtocol",
+    "BaseDocTypeProtocol",
+    "BootstrapProtocol",
+    "Container",
+    "DocType",
+    "Field",
+    "MetaRegistry",
+    "SchemaMapperProtocol",
+    "__version__",
+]

framework_m_core-0.4.1/src/framework_m_core/cli/config.py

@@ -0,0 +1,128 @@
+"""Configuration Management CLI Commands.
+
+This module provides CLI commands for managing Framework M configuration:
+- m config:show: Display current configuration
+- m config:set <key> <value>: Update configuration value
+
+Usage:
+    m config:show                 # Show all config
+    m config:set framework.name myapp
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Annotated, Any
+
+import cyclopts
+
+from framework_m_core.config import (
+    CONFIG_FILE_NAME,
+    DEFAULT_CONFIG,
+    find_config_file,
+    format_config,
+    get_nested_value,
+    load_config,
+    save_config,
+    set_nested_value,
+)
+
+# =============================================================================
+# CLI Commands
+# =============================================================================
+
+
+def config_show_command(
+    key: Annotated[
+        str | None,
+        cyclopts.Parameter(help="Specific key to show (e.g., framework.name)"),
+    ] = None,
+    config_file: Annotated[
+        Path | None,
+        cyclopts.Parameter(name="--config", help="Path to config file"),
+    ] = None,
+) -> None:
+    """Display current configuration.
+
+    Shows the current Framework M configuration from framework_config.toml.
+
+    Examples:
+        m config:show                    # Show all config
+        m config:show framework.name     # Show specific key
+    """
+    config_path = config_file or find_config_file()
+    config = load_config(config_path)
+
+    if not config:
+        print(f"No config found at: {config_path}")
+        print()
+        print("Create a config file with default values:")
+        print("  m config:set framework.name myapp")
+        return
+
+    print(f"Config file: {config_path}")
+    print()
+
+    if key:
+        value = get_nested_value(config, key)
+        if value is not None:
+            print(f"{key} = {value}")
+        else:
+            print(f"Key not found: {key}")
+            raise SystemExit(1)
+    else:
+        print(format_config(config))
+
+
+def config_set_command(
+    key: Annotated[str, cyclopts.Parameter(help="Key to set (e.g., framework.name)")],
+    value: Annotated[str, cyclopts.Parameter(help="Value to set")],
+    config_file: Annotated[
+        Path | None,
+        cyclopts.Parameter(name="--config", help="Path to config file"),
+    ] = None,
+) -> None:
+    """Set a configuration value.
+
+    Updates a value in framework_config.toml, creating the file if needed.
+
+    Examples:
+        m config:set framework.name myapp
+        m config:set apps.installed "myapp,otherapp"
+    """
+    config_path = config_file or find_config_file()
+    config = load_config(config_path) or DEFAULT_CONFIG.copy()
+
+    # Parse value (handle lists)
+    if "," in value:
+        parsed_value: Any = [v.strip() for v in value.split(",")]
+    else:
+        parsed_value = value
+
+    old_value = get_nested_value(config, key)
+    set_nested_value(config, key, parsed_value)
+
+    save_config(config_path, config)
+
+    print(f"Config file: {config_path}")
+    print()
+    if old_value is not None:
+        print(f"  {key}: {old_value} -> {parsed_value}")
+    else:
+        print(f"  {key} = {parsed_value}")
+    print()
+    print("✓ Configuration updated")
+
+
+__all__ = [
+    "CONFIG_FILE_NAME",
+    "DEFAULT_CONFIG",
+    "config_set_command",
+    "config_show_command",
+    "find_config_file",
+    "format_config",
+    "get_nested_value",
+    "load_config",
+    "save_config",
+    "set_nested_value",
+]

framework_m_core-0.4.1/src/framework_m_core/cli/main.py

@@ -0,0 +1,30 @@
+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.plugin_loader import load_plugins
+from framework_m_core.cli.utility import info_command
+
+app = cyclopts.App(
+    name="m",
+    version=__version__,
+    help="Framework M CLI",
+)
+
+# Register core commands
+app.command(info_command, name="info")
+
+# Config commands
+app.command(config_show_command, name="config:show")
+app.command(config_set_command, name="config:set")
+
+# Load plugins
+load_plugins(app)
+
+
+def main() -> None:
+    app()
+
+
+if __name__ == "__main__":
+    main()