Framework M
The complete metadata-driven business application framework for Python 3.12+.
Official Website: frameworkm.dev
📦 Metapackage: This is the primary Framework M package. Installing it gives you everything required to build applications. For individual components, see the Related Packages section.
Overview
Framework M is inspired by Frappe Framework but built with modern Python practices:
- Hexagonal Architecture: Clean separation via Ports & Adapters
- Async-First: Native asyncio with Litestar and SQLAlchemy
- Type-Safe: 100% type hints, mypy strict compatible
- Stateless: JWT/Token auth, no server-side sessions
- Metadata-Driven: Define DocTypes as Pydantic models
Installation
pip install framework-m
Or with uv:
uv add framework-m
Quick Start
1. Define a DocType
from framework_m import DocType, Field
class Todo(DocType):
"""A simple task document."""
title: str = Field(description="Task title")
description: str | None = Field(default=None, description="Task details")
is_completed: bool = Field(default=False, description="Completion status")
priority: int = Field(default=1, ge=1, le=5, description="Priority (1-5)")
2. Use the CLI
# Show version
m --version
# Show framework info
m info
# Start production server
m prod
# Start development server
m dev
Architecture & Features
Framework M follows a strict Ports & Adapters (Hexagonal) architecture. The core domain logic is isolated from infrastructure concerns.
- Primary Adapters: HTTP API (Litestar), CLI, WebSockets, Job Workers.
- Core Domain: DocTypes, Controllers, and Business Logic.
- Ports (Interfaces): Defined protocols for Repositories, Events, Storage, etc.
- Secondary Adapters: Implementations for PostgreSQL, Redis, S3, etc.
Key Capabilities:
- Automatic CRUD operations (
RepositoryProtocol) - Event-driven architecture (
EventBusProtocol) - Row-level security & permissions (
PermissionProtocol) - Background jobs (
JobQueueProtocol) - File storage abstraction (
StorageProtocol)
Technology Stack
- Web Framework: Litestar 2.0+
- ORM: SQLAlchemy 2.0 (Async)
- Validation: Pydantic V2
- Task Queue: Taskiq + NATS JetStream
- DI Container: dependency-injector
- Database: PostgreSQL (default), SQLite (testing)
- Cache: Redis
- Events: NATS JetStream
Development
# Clone and setup
git clone https://gitlab.com/framework-m/framework-m.git
cd framework-m
# Install dependencies
uv sync --all-packages --all-extras --all-groups
# Run tests
uv run pytest
# Type checking
uv run mypy src/framework_m --strict
# Linting
uv run ruff check .
uv run ruff format .
Documentation
Related Packages
Framework M is split into modular packages:
| Package | Description |
|---|---|
framework-m |
This package - Metapackage with CLI, kernel, and re-exports |
framework-m-core |
Core protocols and dependency injection |
framework-m-standard |
Default adapters (SQLAlchemy, Redis, Litestar) |
framework-m-studio |
Visual DocType builder UI |
License
Apache 2.0 License - see LICENSE for details.
Acknowledgments
Inspired by Frappe Framework, reimagined with:
- Modern Python (3.12+, async/await, type hints)
- Clean architecture (Hexagonal/Ports & Adapters)
- No global state (Dependency Injection)
- Code-first schemas (Pydantic, not database JSON)
1 maintainer
Metadata
1 maintainer
Release files for framework-m 0.16.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| framework_m-0.16.12.tar.gz | 52.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| framework_m-0.16.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 61.0 kB
Release files / framework_m-0.16.12.tar.gz
| Download URL | framework_m-0.16.12.tar.gz |
|---|---|
| Size | 52.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f67afde0601b125d8e7863d084009a7eab2ac15e5a41077395b2eb0bf4f1dcf2
|
|
BLAKE2b-256 checksum How to use checksums |
2e78729acbf6f5b66d31153755f86078fb9b55b85e3f6120078cdee6bf6c5035
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / framework_m-0.16.12-py3-none-any.whl
| Download URL | framework_m-0.16.12-py3-none-any.whl |
|---|---|
| Size | 8.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
993cbb55d29e62e793a65c087c4851629885a833ce7f63eca8e8320b703b3e6e
|
|
BLAKE2b-256 checksum How to use checksums |
f98c4e6d9de980b7127fed0c4bd31bd1ef11180b89b46626d92624f53823b2b1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
