framework-m 0.2.5__tar.gz

framework_m-0.2.5/.gitignore

@@ -0,0 +1,107 @@
+# 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

framework_m-0.2.5/CHANGELOG.md

@@ -0,0 +1,96 @@
+# Changelog
+
+## framework-m v0.2.5
+
+### Bug Fixes
+
+- add pypi and pipeline badges to readme (62590fc)
+
+
+## framework-m v0.2.4
+
+### Bug Fixes
+
+- robust package detection and safe MR title truncation (36385b6)
+- improve changelog extraction for GitLab release pages (bb636b0)
+
+
+## framework-m v0.2.3
+
+### Bug Fixes
+
+- use show-ref for robust tag check and clear local ghost tags (79563c5)
+
+
+## framework-m v0.2.2
+
+### Bug Fixes
+
+- 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)
+
+
+## framework-m v0.2.1
+
+### Bug Fixes
+
+- 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)
+
+
+## framework-m 0.2.0
+
+### Features
+
+- add unique constraint support and refine docs (5f9af98)
+- 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)
+- 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
+
+- 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)
+- 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 0.1.0
+
+### Features
+
+- Initial release of Framework M

framework_m-0.2.5/PKG-INFO

@@ -0,0 +1,231 @@
+Metadata-Version: 2.4
+Name: framework-m
+Version: 0.2.5
+Summary: A modern, metadata-driven business application framework
+Project-URL: Homepage, https://gitlab.com/castlecraft/framework-m
+Project-URL: Documentation, https://gitlab.com/castlecraft/framework-m#readme
+Project-URL: Repository, https://gitlab.com/castlecraft/framework-m
+Author: Framework M Contributors
+License: MIT
+Keywords: async,business,doctype,framework,metadata
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: aioboto3>=15.5.0
+Requires-Dist: aiofiles>=25.1.0
+Requires-Dist: alembic>=1.13.0
+Requires-Dist: argon2-cffi>=23.1.0
+Requires-Dist: asyncpg>=0.29.0
+Requires-Dist: boto3-stubs>=1.42.21
+Requires-Dist: botocore-stubs>=1.42.21
+Requires-Dist: cyclopts>=3.0.0
+Requires-Dist: dependency-injector>=4.41.0
+Requires-Dist: litestar[standard]>=2.0.0
+Requires-Dist: nats-py>=2.0.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: redis>=5.0.0
+Requires-Dist: sqlalchemy[asyncio]>=2.0.0
+Requires-Dist: taskiq-nats>=0.4.0
+Requires-Dist: taskiq>=0.11.0
+Requires-Dist: types-aiobotocore>=3.1.0
+Description-Content-Type: text/markdown
+
+# Framework M
+
+A modern, metadata-driven business application framework in Python 3.12+.
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![PyPI version](https://badge.fury.io/py/framework-m.svg)](https://badge.fury.io/py/framework-m)
+[![GitLab Pipeline Status](https://gitlab.com/castlecraft/framework-m/badges/main/pipeline.svg)](https://gitlab.com/castlecraft/framework-m/-/pipelines)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Type checked: mypy](https://img.shields.io/badge/type%20checked-mypy-blue.svg)](https://mypy-lang.org/)
+
+## Overview
+
+Framework M is inspired by [Frappe Framework](https://frappeframework.com/) but built from scratch 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
+
+```bash
+pip install framework-m
+```
+
+Or with `uv`:
+
+```bash
+uv add framework-m
+```
+
+## Quick Start
+
+### 1. Define a DocType
+
+```python
+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
+
+```bash
+# Show version
+m --version
+
+# Show framework info
+m info
+
+# Start development server (coming soon)
+m start
+```
+
+## Features
+
+### Metadata-Driven DocTypes
+
+DocTypes are Pydantic models with automatic:
+- Database table generation
+- REST API endpoints
+- JSON Schema for frontends
+- Validation and serialization
+
+### Hexagonal Architecture
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│                     Primary Adapters                        │
+│         (HTTP API, CLI, WebSocket, Background Jobs)         │
+└─────────────────────────────────────────────────────────────┘
+                              │
+                              ▼
+┌─────────────────────────────────────────────────────────────┐
+│                      Core Domain                            │
+│              (DocTypes, Controllers, Business Logic)        │
+│                                                             │
+│  ┌─────────────┐  ┌───────────────┐  ┌──────────────┐       │
+│  │ BaseDocType │  │ BaseController│  │ MetaRegistry │       │
+│  └─────────────┘  └───────────────┘  └──────────────┘       │
+└─────────────────────────────────────────────────────────────┘
+                              │
+                              ▼
+┌─────────────────────────────────────────────────────────────┐
+│                    Ports (Interfaces)                       │
+│  RepositoryProtocol │ EventBusProtocol │ PermissionProtocol │
+│  StorageProtocol    │ JobQueueProtocol │ CacheProtocol      │
+└─────────────────────────────────────────────────────────────┘
+                              │
+                              ▼
+┌─────────────────────────────────────────────────────────────┐
+│                   Secondary Adapters                        │
+│     (PostgreSQL, Redis, S3, SMTP, External APIs)            │
+└─────────────────────────────────────────────────────────────┘
+```
+
+### Built-in Protocols
+
+| 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 |
+
+### Extensibility
+
+Override any adapter via Python entrypoints:
+
+```toml
+# pyproject.toml
+[project.entry-points."framework_m.overrides"]
+repository = "my_app.adapters:CustomRepository"
+```
+
+## Technology Stack
+
+- **Web Framework**: [Litestar](https://litestar.dev/) 2.0+
+- **ORM**: [SQLAlchemy](https://www.sqlalchemy.org/) 2.0 (Async)
+- **Validation**: [Pydantic](https://docs.pydantic.dev/) V2
+- **Task Queue**: [Taskiq](https://taskiq-python.github.io/) + NATS JetStream
+- **DI Container**: [dependency-injector](https://python-dependency-injector.ets-labs.org/)
+- **Database**: PostgreSQL (default), SQLite (testing)
+- **Cache/Events**: Redis
+
+## Project Structure
+
+```
+libs/framework-m/
+├── src/framework_m/
+│   ├── core/
+│   │   ├── domain/         # DocType, Controller, Mixins
+│   │   └── interfaces/     # Protocol definitions (Ports)
+│   ├── adapters/           # Infrastructure implementations
+│   ├── cli/                # CLI commands
+│   └── public/             # Built-in DocTypes
+└── tests/
+```
+
+## Development
+
+```bash
+# Clone and setup
+git clone https://gitlab.com/castlecraft/framework-m.git
+cd framework-m
+
+# Install dependencies
+uv sync --all-extras
+
+# Run tests
+uv run pytest
+
+# Type checking
+uv run mypy src/framework_m --strict
+
+# Linting
+uv run ruff check .
+uv run ruff format .
+```
+
+## Documentation
+
+- [Architecture Overview](https://gitlab.com/castlecraft/framework-m/blob/main/ARCHITECTURE.md)
+- [Contributing Guide](https://gitlab.com/castlecraft/framework-m/blob/main/CONTRIBUTING.md)
+- [Phase Checklists](https://gitlab.com/castlecraft/framework-m/tree/main/checklists)
+
+## License
+
+MIT License - see [LICENSE](https://gitlab.com/castlecraft/framework-m/blob/main/LICENSE) for details.
+
+## Acknowledgments
+
+Inspired by [Frappe Framework](https://frappeframework.com/), 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)

framework_m-0.2.5/README.md

@@ -0,0 +1,191 @@
+# Framework M
+
+A modern, metadata-driven business application framework in Python 3.12+.
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![PyPI version](https://badge.fury.io/py/framework-m.svg)](https://badge.fury.io/py/framework-m)
+[![GitLab Pipeline Status](https://gitlab.com/castlecraft/framework-m/badges/main/pipeline.svg)](https://gitlab.com/castlecraft/framework-m/-/pipelines)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Type checked: mypy](https://img.shields.io/badge/type%20checked-mypy-blue.svg)](https://mypy-lang.org/)
+
+## Overview
+
+Framework M is inspired by [Frappe Framework](https://frappeframework.com/) but built from scratch 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
+
+```bash
+pip install framework-m
+```
+
+Or with `uv`:
+
+```bash
+uv add framework-m
+```
+
+## Quick Start
+
+### 1. Define a DocType
+
+```python
+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
+
+```bash
+# Show version
+m --version
+
+# Show framework info
+m info
+
+# Start development server (coming soon)
+m start
+```
+
+## Features
+
+### Metadata-Driven DocTypes
+
+DocTypes are Pydantic models with automatic:
+- Database table generation
+- REST API endpoints
+- JSON Schema for frontends
+- Validation and serialization
+
+### Hexagonal Architecture
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│                     Primary Adapters                        │
+│         (HTTP API, CLI, WebSocket, Background Jobs)         │
+└─────────────────────────────────────────────────────────────┘
+                              │
+                              ▼
+┌─────────────────────────────────────────────────────────────┐
+│                      Core Domain                            │
+│              (DocTypes, Controllers, Business Logic)        │
+│                                                             │
+│  ┌─────────────┐  ┌───────────────┐  ┌──────────────┐       │
+│  │ BaseDocType │  │ BaseController│  │ MetaRegistry │       │
+│  └─────────────┘  └───────────────┘  └──────────────┘       │
+└─────────────────────────────────────────────────────────────┘
+                              │
+                              ▼
+┌─────────────────────────────────────────────────────────────┐
+│                    Ports (Interfaces)                       │
+│  RepositoryProtocol │ EventBusProtocol │ PermissionProtocol │
+│  StorageProtocol    │ JobQueueProtocol │ CacheProtocol      │
+└─────────────────────────────────────────────────────────────┘
+                              │
+                              ▼
+┌─────────────────────────────────────────────────────────────┐
+│                   Secondary Adapters                        │
+│     (PostgreSQL, Redis, S3, SMTP, External APIs)            │
+└─────────────────────────────────────────────────────────────┘
+```
+
+### Built-in Protocols
+
+| 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 |
+
+### Extensibility
+
+Override any adapter via Python entrypoints:
+
+```toml
+# pyproject.toml
+[project.entry-points."framework_m.overrides"]
+repository = "my_app.adapters:CustomRepository"
+```
+
+## Technology Stack
+
+- **Web Framework**: [Litestar](https://litestar.dev/) 2.0+
+- **ORM**: [SQLAlchemy](https://www.sqlalchemy.org/) 2.0 (Async)
+- **Validation**: [Pydantic](https://docs.pydantic.dev/) V2
+- **Task Queue**: [Taskiq](https://taskiq-python.github.io/) + NATS JetStream
+- **DI Container**: [dependency-injector](https://python-dependency-injector.ets-labs.org/)
+- **Database**: PostgreSQL (default), SQLite (testing)
+- **Cache/Events**: Redis
+
+## Project Structure
+
+```
+libs/framework-m/
+├── src/framework_m/
+│   ├── core/
+│   │   ├── domain/         # DocType, Controller, Mixins
+│   │   └── interfaces/     # Protocol definitions (Ports)
+│   ├── adapters/           # Infrastructure implementations
+│   ├── cli/                # CLI commands
+│   └── public/             # Built-in DocTypes
+└── tests/
+```
+
+## Development
+
+```bash
+# Clone and setup
+git clone https://gitlab.com/castlecraft/framework-m.git
+cd framework-m
+
+# Install dependencies
+uv sync --all-extras
+
+# Run tests
+uv run pytest
+
+# Type checking
+uv run mypy src/framework_m --strict
+
+# Linting
+uv run ruff check .
+uv run ruff format .
+```
+
+## Documentation
+
+- [Architecture Overview](https://gitlab.com/castlecraft/framework-m/blob/main/ARCHITECTURE.md)
+- [Contributing Guide](https://gitlab.com/castlecraft/framework-m/blob/main/CONTRIBUTING.md)
+- [Phase Checklists](https://gitlab.com/castlecraft/framework-m/tree/main/checklists)
+
+## License
+
+MIT License - see [LICENSE](https://gitlab.com/castlecraft/framework-m/blob/main/LICENSE) for details.
+
+## Acknowledgments
+
+Inspired by [Frappe Framework](https://frappeframework.com/), 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)

framework_m-0.2.5/alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.