framework-m-studio 0.2.2__tar.gz

framework_m_studio-0.2.2/.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_studio-0.2.2/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+## framework-m-studio v0.2.2
+
+### Bug Fixes
+
+- add badges to readme (012333b)
+
+
+## framework-m-studio v0.2.1
+
+### Bug Fixes
+
+- modernize aesthetics (300cdda)
+
+
+## framework-m-studio 0.2.0
+
+### Features
+
+- implement path prefix architecture for UI/API separation (7a8d2d2)
+- add cloud workspace & git adapter, controller scaffolding and sandbox (a7a4a3e)
+- implement Studio backend and frontend (abf5d03)
+
+### Bug Fixes
+
+- include static files in package for PyPI publishing (565bcb8)
+

framework_m_studio-0.2.2/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: framework-m-studio
+Version: 0.2.2
+Summary: Framework M Studio - Visual DocType Builder & Developer Tools
+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: codegen,developer-tools,doctype,framework,studio
+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: framework-m
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: libcst>=1.0.0
+Description-Content-Type: text/markdown
+
+# Framework M Studio
+
+Visual DocType builder and developer tools for Framework M.
+
+[![PyPI version](https://badge.fury.io/py/framework-m-studio.svg)](https://badge.fury.io/py/framework-m-studio)
+[![GitLab Pipeline Status](https://gitlab.com/castlecraft/framework-m/badges/main/pipeline.svg)](https://gitlab.com/castlecraft/framework-m/-/pipelines)
+
+## Overview
+
+`framework-m-studio` provides development-time tools that are NOT included in the production runtime:
+
+- **Studio UI**: Visual DocType builder (React + Vite)
+- **Code Generators**: LibCST-based Python code generation
+- **DevTools CLI**: `m codegen`, `m docs:generate`
+
+> **Note:** Studio is for developers to build DocTypes. The **Desk** (end-user data management UI) is a separate frontend that connects to the Framework M backend.
+
+## Installation
+
+```bash
+# Add to your project's dev dependencies
+uv add --dev framework-m-studio
+```
+
+## Usage
+
+```bash
+# Start Studio UI
+m studio
+
+# Generate TypeScript client from OpenAPI
+m codegen client --lang ts --out ./frontend/src/api
+```
+
+## Development
+
+```bash
+cd apps/studio
+uv sync
+uv run pytest
+```

framework_m_studio-0.2.2/README.md

@@ -0,0 +1,41 @@
+# Framework M Studio
+
+Visual DocType builder and developer tools for Framework M.
+
+[![PyPI version](https://badge.fury.io/py/framework-m-studio.svg)](https://badge.fury.io/py/framework-m-studio)
+[![GitLab Pipeline Status](https://gitlab.com/castlecraft/framework-m/badges/main/pipeline.svg)](https://gitlab.com/castlecraft/framework-m/-/pipelines)
+
+## Overview
+
+`framework-m-studio` provides development-time tools that are NOT included in the production runtime:
+
+- **Studio UI**: Visual DocType builder (React + Vite)
+- **Code Generators**: LibCST-based Python code generation
+- **DevTools CLI**: `m codegen`, `m docs:generate`
+
+> **Note:** Studio is for developers to build DocTypes. The **Desk** (end-user data management UI) is a separate frontend that connects to the Framework M backend.
+
+## Installation
+
+```bash
+# Add to your project's dev dependencies
+uv add --dev framework-m-studio
+```
+
+## Usage
+
+```bash
+# Start Studio UI
+m studio
+
+# Generate TypeScript client from OpenAPI
+m codegen client --lang ts --out ./frontend/src/api
+```
+
+## Development
+
+```bash
+cd apps/studio
+uv sync
+uv run pytest
+```

framework_m_studio-0.2.2/docs/api/index.md

@@ -0,0 +1,3 @@
+# API Reference
+
+## DocTypes

framework_m_studio-0.2.2/docs/user-guide.md

@@ -0,0 +1,75 @@
+# Studio User Guide
+
+## Overview
+
+Framework-M Studio is a visual development environment for creating and managing DocTypes.
+
+## Starting Studio
+
+```bash
+# Start Studio server
+uv run m studio
+
+# Or with a specific port
+uv run m studio --port 8000
+```
+
+Then open http://localhost:8000/studio in your browser.
+
+## Creating a DocType
+
+1. **Navigate to DocTypes** - Click "DocTypes" in the sidebar
+2. **Click "Create"** - Opens the DocType editor
+3. **Enter Name** - Use PascalCase (e.g., `SalesOrder`)
+4. **Add Fields** - Click "Add Field" and configure each field
+5. **Save** - Click "Save" to generate the Python file
+
+## Adding Fields
+
+Each field has:
+- **Name** - Python identifier (snake_case)
+- **Type** - Select from: Text, Integer, Float, Boolean, Date, etc.
+- **Required** - Whether the field is mandatory
+- **Default** - Optional default value
+- **Validators** - Min/max length, pattern, min/max value
+
+## Configuring Permissions
+
+Permissions are defined in the DocType's Config class:
+- Enable in the Properties panel
+- Set `is_submittable = True` for workflow-enabled docs
+
+## Using Git Mode
+
+**Viewing Status:**
+1. Click the Git icon in the sidebar
+2. See current branch, modified files, and commit history
+
+**Committing Changes:**
+1. Make changes to DocTypes
+2. Open Git panel
+3. Enter commit message
+4. Click "Commit"
+
+**Pushing to Remote:**
+1. Commit your changes first
+2. Click "Push" to upload to GitHub
+
+## Sandbox Mode
+
+Test DocTypes without saving:
+1. Open a DocType
+2. Switch to "Sandbox" tab
+3. Use auto-generated mock data
+4. Test CRUD operations
+5. Verify validation rules
+
+## Controller Hooks
+
+Available lifecycle hooks:
+- `validate` - Before save validation
+- `before_save` - Pre-persistence logic
+- `after_save` - Post-save side effects
+- `before_delete` - Pre-delete cleanup
+
+Edit in the "Controller" tab.

framework_m_studio-0.2.2/pyproject.toml

@@ -0,0 +1,138 @@
+[project]
+name = "framework-m-studio"
+version = "0.2.2"
+description = "Framework M Studio - Visual DocType Builder & Developer Tools"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.12"
+authors = [
+    { name = "Framework M Contributors" }
+]
+keywords = ["framework", "studio", "doctype", "codegen", "developer-tools"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Framework :: AsyncIO",
+    "Typing :: Typed",
+]
+
+dependencies = [
+    "framework-m",
+    # Code generation
+    "libcst>=1.0.0",
+    "jinja2>=3.1.0",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "pytest-cov>=4.1.0",
+    "mypy>=1.8.0",
+    "ruff>=0.3.0",
+    "httpx>=0.27.0",
+    # Release tools
+    "python-semantic-release>=9.0.0",
+    "build>=1.0.0",
+    "twine>=5.0.0",
+]
+
+[project.entry-points."framework_m.cli_commands"]
+# These commands override/extend base CLI when framework-m-studio is installed
+codegen = "framework_m_studio.cli:codegen_app"
+studio = "framework_m_studio.cli:studio_app"
+docs = "framework_m_studio.cli:docs_app"
+
+[project.urls]
+Homepage = "https://gitlab.com/castlecraft/framework-m"
+Documentation = "https://gitlab.com/castlecraft/framework-m#readme"
+Repository = "https://gitlab.com/castlecraft/framework-m"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    ".venv",
+    ".pytest_cache",
+    ".mypy_cache",
+    ".ruff_cache",
+    "__pycache__",
+    "studio_ui/node_modules",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/framework_m_studio"]
+# static/ is included automatically since it's under src/framework_m_studio/
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+addopts = "-v --tb=short"
+
+[tool.coverage.run]
+source = ["src/framework_m_studio"]
+branch = true
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+warn_return_any = true
+warn_unused_ignores = true
+disallow_untyped_defs = true
+mypy_path = "src"
+explicit_package_bases = true
+exclude = [
+    "tests/",
+    ".venv/",
+]
+
+[[tool.mypy.overrides]]
+module = "framework_m.core.fields.registry"
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 88
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "C4", "PTH", "RUF"]
+ignore = ["E501", "B008"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.ruff.lint.isort]
+known-first-party = ["framework_m_studio", "framework_m"]
+
+# =============================================================================
+# Semantic Release Configuration
+# =============================================================================
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:project.version"]
+branch = "main"
+tag_format = "studio-v{version}"
+major_on_zero = false  # Keep 0.x.y versions (breaking changes bump minor, not major)
+build_command = """
+    python -m build --sdist --wheel --outdir dist/
+    git add pyproject.toml CHANGELOG.md
+"""
+commit_message = "chore(release): framework-m-studio v{version}"
+
+[tool.semantic_release.changelog]
+changelog_file = "CHANGELOG.md"
+
+[tool.semantic_release.remote]
+type = "gitlab"
+token = { env = "GITLAB_TOKEN" }
+
+[tool.semantic_release.publish]
+upload_to_vcs_release = true
+

framework_m_studio-0.2.2/src/framework_m_studio/__init__.py

@@ -0,0 +1,16 @@
+"""Framework M Studio - Visual DocType Builder & Developer Tools.
+
+This package provides development-time tools for Framework M:
+- Visual DocType builder (Studio UI)
+- LibCST-based code generators
+- Extended CLI commands (codegen, docs)
+
+This package is separated from framework-m core to keep the
+runtime lightweight. Install as a dev dependency.
+"""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+__all__ = ["__version__"]