framework-m-core 0.8.0

Core protocols and dependency injection for Framework M

Framework M Core

Core protocols and dependency injection container for Framework M.

Installation

pip install framework-m-core

Or with uv:

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:

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:

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

Apache 2.0 License - see LICENSE for details.