cmsdk 1.0.0__tar.gz

cmsdk-1.0.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: cmsdk
+Version: 1.0.0
+Summary: A modern Python SDK for generating dynamic JSON interfaces
+Author: JsonApp Team
+License: MIT
+Keywords: json,interface,form-builder,sdk,dynamic-ui,mobile-apps
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: cryptography>=41.0.0
+Requires-Dist: markdown>=3.4.0
+Requires-Dist: bleach>=6.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: mypy>=1.5.0; extra == "dev"
+Requires-Dist: ruff>=0.0.280; extra == "dev"
+
+# JSONApp Python SDK
+
+> **Note**: This is the Python port of the JSONApp SDK. This repository is a monorepo containing multiple language implementations. See the [root README](../README.md) for an overview.
+
+A stateless backend library for building views that are sent to renderers (mobile or web). This is the Python port of the TypeScript JSONApp SDK.
+
+## Features
+
+- **Stateless Architecture**: No internal state, perfect for serverless and microservices
+- **Ed25519 Signing**: Secure view signing and verification using Ed25519 cryptography
+- **12 View Types**: Form, Reader, ActionList, ActionGrid, QRScan, QRDisplay, Message, Card, Carousel, Timeline, Media, Map
+- **Type Safety**: Full type definitions using Python dataclasses and type hints
+- **Validation**: Built-in field and form validation
+- **Security**: XSS protection, URL validation, input sanitization
+
+## Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+## Quick Start
+
+```python
+from jsonapp import JsonApp, JsonAppConfig
+from jsonapp.views import FormView
+
+# Initialize JsonApp
+config = JsonAppConfig(
+    app_id="my-app",
+    view_expiration_minutes=60,
+)
+app = JsonApp(config)
+
+# Create a form view
+form = app.create_form_view("registration", "User Registration")
+form.add_text_field("name", "Full Name", is_required=True)
+form.add_email_field("email", "Email", is_required=True)
+form.submit_button("Register")
+
+# Serve with signature
+response = app.serve(form)
+print(response.view)  # The view JSON
+print(response.signature)  # Ed25519 signature
+```
+
+## View Types
+
+### FormView
+Create forms with various field types (text, email, password, select, file, GPS, etc.)
+
+### ReaderView
+Display rich content with paragraphs, images, markdown, tables, code blocks, etc.
+
+### ActionListView / ActionGridView
+Display lists or grids of actions
+
+### QRScanView / QRDisplayView
+QR code scanning and display
+
+### MessageView
+Display messages with actions
+
+### CardView
+Display card-based content with stats and sections
+
+### CarouselView
+Display carousel slides
+
+### TimelineView
+Display chronological events
+
+### MediaView
+Display audio and video playlists
+
+### MapView
+Display geographic data on maps
+
+## API Parity
+
+The Python SDK maintains API parity with the TypeScript version:
+
+- Same factory methods: `app.create_form_view()`, `app.create_reader_view()`, etc.
+- Same fluent API: `view.add_field().set_intro().submit_button()` (or `set_note()` for backward compatibility)
+- Same validation and security features
+- Same Ed25519 signing and verification
+
+## Examples
+
+See `examples/basic_usage.py` for a complete example.
+
+## Requirements
+
+- Python 3.10+
+- cryptography (for Ed25519)
+- markdown (for ReaderView markdown support)
+- bleach (for HTML sanitization)
+
+## Status
+
+✅ Core classes (BaseView, JsonApp)
+✅ All 12 view types
+✅ Type definitions
+✅ Error handling
+✅ Validation utilities
+✅ Ed25519 signing/verification
+✅ Examples
+
+## License
+
+Same as the TypeScript SDK.

cmsdk-1.0.0/README.md

@@ -0,0 +1,111 @@
+# JSONApp Python SDK
+
+> **Note**: This is the Python port of the JSONApp SDK. This repository is a monorepo containing multiple language implementations. See the [root README](../README.md) for an overview.
+
+A stateless backend library for building views that are sent to renderers (mobile or web). This is the Python port of the TypeScript JSONApp SDK.
+
+## Features
+
+- **Stateless Architecture**: No internal state, perfect for serverless and microservices
+- **Ed25519 Signing**: Secure view signing and verification using Ed25519 cryptography
+- **12 View Types**: Form, Reader, ActionList, ActionGrid, QRScan, QRDisplay, Message, Card, Carousel, Timeline, Media, Map
+- **Type Safety**: Full type definitions using Python dataclasses and type hints
+- **Validation**: Built-in field and form validation
+- **Security**: XSS protection, URL validation, input sanitization
+
+## Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+## Quick Start
+
+```python
+from jsonapp import JsonApp, JsonAppConfig
+from jsonapp.views import FormView
+
+# Initialize JsonApp
+config = JsonAppConfig(
+    app_id="my-app",
+    view_expiration_minutes=60,
+)
+app = JsonApp(config)
+
+# Create a form view
+form = app.create_form_view("registration", "User Registration")
+form.add_text_field("name", "Full Name", is_required=True)
+form.add_email_field("email", "Email", is_required=True)
+form.submit_button("Register")
+
+# Serve with signature
+response = app.serve(form)
+print(response.view)  # The view JSON
+print(response.signature)  # Ed25519 signature
+```
+
+## View Types
+
+### FormView
+Create forms with various field types (text, email, password, select, file, GPS, etc.)
+
+### ReaderView
+Display rich content with paragraphs, images, markdown, tables, code blocks, etc.
+
+### ActionListView / ActionGridView
+Display lists or grids of actions
+
+### QRScanView / QRDisplayView
+QR code scanning and display
+
+### MessageView
+Display messages with actions
+
+### CardView
+Display card-based content with stats and sections
+
+### CarouselView
+Display carousel slides
+
+### TimelineView
+Display chronological events
+
+### MediaView
+Display audio and video playlists
+
+### MapView
+Display geographic data on maps
+
+## API Parity
+
+The Python SDK maintains API parity with the TypeScript version:
+
+- Same factory methods: `app.create_form_view()`, `app.create_reader_view()`, etc.
+- Same fluent API: `view.add_field().set_intro().submit_button()` (or `set_note()` for backward compatibility)
+- Same validation and security features
+- Same Ed25519 signing and verification
+
+## Examples
+
+See `examples/basic_usage.py` for a complete example.
+
+## Requirements
+
+- Python 3.10+
+- cryptography (for Ed25519)
+- markdown (for ReaderView markdown support)
+- bleach (for HTML sanitization)
+
+## Status
+
+✅ Core classes (BaseView, JsonApp)
+✅ All 12 view types
+✅ Type definitions
+✅ Error handling
+✅ Validation utilities
+✅ Ed25519 signing/verification
+✅ Examples
+
+## License
+
+Same as the TypeScript SDK.

cmsdk-1.0.0/cmsdk/__init__.py

@@ -0,0 +1,93 @@
+"""
+JSONApp SDK for Python
+A stateless backend library for building views that are sent to renderers (mobile or web)
+"""
+
+from .core.jsonapp import JsonApp, JsonAppConfig, SecureViewResponse
+from .core.base_view import BaseView
+from .views import (
+    FormView,
+    ReaderView,
+    ActionListView,
+    ActionGridView,
+    QRScanView,
+    QRDisplayView,
+    MessageView,
+    CardView,
+    CarouselView,
+    TimelineView,
+    MediaView,
+    MapView,
+)
+from .errors import (
+    JsonAppError,
+    ValidationError,
+    FieldValidationError,
+    SecurityError,
+    SignatureVerificationError,
+    ViewExpiredError,
+    AppIdMismatchError,
+    ConfigurationError,
+    MissingRequiredParameterError,
+    InvalidParameterError,
+    DataError,
+    FieldNotFoundError,
+    ActionNotFoundError,
+    ElementNotFoundError,
+    EmptyCollectionError,
+    ViewError,
+    ViewNotFoundError,
+    ViewValidationError,
+    MaxViewsExceededError,
+    ExternalError,
+    MarkdownParseError,
+    NoProcessContextError,
+    ERROR_CODES,
+)
+
+__version__ = "3.0.0"
+
+__all__ = [
+    # Core classes
+    "JsonApp",
+    "JsonAppConfig",
+    "SecureViewResponse",
+    "BaseView",
+    # View classes
+    "FormView",
+    "ReaderView",
+    "ActionListView",
+    "ActionGridView",
+    "QRScanView",
+    "QRDisplayView",
+    "MessageView",
+    "CardView",
+    "CarouselView",
+    "TimelineView",
+    "MediaView",
+    "MapView",
+    # Error classes
+    "JsonAppError",
+    "ValidationError",
+    "FieldValidationError",
+    "SecurityError",
+    "SignatureVerificationError",
+    "ViewExpiredError",
+    "AppIdMismatchError",
+    "ConfigurationError",
+    "MissingRequiredParameterError",
+    "InvalidParameterError",
+    "DataError",
+    "FieldNotFoundError",
+    "ActionNotFoundError",
+    "ElementNotFoundError",
+    "EmptyCollectionError",
+    "ViewError",
+    "ViewNotFoundError",
+    "ViewValidationError",
+    "MaxViewsExceededError",
+    "ExternalError",
+    "MarkdownParseError",
+    "NoProcessContextError",
+    "ERROR_CODES",
+]

cmsdk-1.0.0/cmsdk/core/__init__.py

@@ -0,0 +1,12 @@
+"""Core classes for JSONApp SDK"""
+
+from .base_view import BaseView
+from .jsonapp import JsonApp, JsonAppConfig, SecureViewResponse
+
+__all__ = [
+    "BaseView",
+    "JsonApp",
+    "JsonAppConfig",
+    "SecureViewResponse",
+]
+