SDK for python

.gitignore

@@ -7,6 +7,7 @@ data
 node_modules
 datastar-website
 *_bin
-.DS_Store
 *.qtpl.go
 */java/target/
+*.pyc
+__pycache__

build/consts_python.qtpl

@@ -0,0 +1,60 @@
+{% import "strings" %}
+{% import "fmt" %}
+{%- func pythonConsts(data *ConstTemplateData) -%}
+# {%s data.DoNotEdit %}
+from enum import StrEnum
+
+{%- for _, enum := range data.Enums -%}
+#region {%s= enum.Description %}
+class {%s enum.Name.Pascal %}(StrEnum):
+{%- for _, entry := range enum.Values -%}
+    # {%s= entry.Description %}
+    {%s enum.Name.Pascal %}{%s entry.Name.Pascal %} = "{%s entry.Value %}"
+
+{%- endfor -%}
+#endregion {%s enum.Name.Pascal %}
+
+{%- endfor -%}
+#endregion Enums
+
+DATASTAR_KEY = "{%s data.DatastarKey %}"
+VERSION                   = "{%s data.Version %}"
+VERSION_CLIENT_BYTE_SIZE     = {%d data.VersionClientByteSize %}
+VERSION_CLIENT_BYTE_SIZE_GZIP = {%d data.VersionClientByteSizeGzip %}
+
+#region Default durations
+
+{%- for _, d := range data.DefaultDurations -%}
+# {%s= d.Description %}
+Default{%s d.Name.Pascal %} = {%d durationToMs(d.Duration) %}
+{%- endfor -%}
+
+#endregion Default durations
+
+#region Default strings
+
+{%- for _, s := range data.DefaultStrings -%}
+# {%s= s.Description %}
+Default{%s s.Name.Pascal %} = "{%s s.Value %}"
+{%- endfor -%}
+
+#endregion Default strings
+
+#region Dataline literals
+{%- for _, literal := range data.DatalineLiterals -%}
+{%s literal.Pascal %}DatalineLiteral = "{%s literal.Camel %}"
+{%- endfor -%}
+#endregion Dataline literals
+
+#region Default booleans
+
+{%- for _, b := range data.DefaultBools -%}
+# {%s= b.Description %}
+Default{%s b.Name.Pascal %} = {%s strings.Title(fmt.Sprintf("%v", b.Value)) %}
+
+{%- endfor -%}
+#endregion Default booleans
+
+#region Enums
+
+{%- endfunc -%}

build/run.go

@@ -44,7 +44,7 @@ func extractVersion() (string, error) {
 	// Write out the version to the version file.
 	versionPath := "library/src/engine/version.ts"
 	versionContents := fmt.Sprintf("export const VERSION = '%s';\n", version)
-	if err := os.WriteFile(versionPath, []byte(versionContents), 0644); err != nil {
+	if err := os.WriteFile(versionPath, []byte(versionContents), 0o644); err != nil {
 		return "", fmt.Errorf("error writing version file: %w", err)
 	}
 
@@ -143,12 +143,13 @@ func writeOutConsts(version string) error {
 		"sdk/java/src/main/java/starfederation/datastar/Consts.java":                  javaConsts,
 		"sdk/java/src/main/java/starfederation/datastar/enums/EventType.java":         javaEventType,
 		"sdk/java/src/main/java/starfederation/datastar/enums/FragmentMergeMode.java": javaFragmentMergeMode,
+		"sdk/python/src/datastar_py/consts.py":                                        pythonConsts,
 	}
 
 	for path, tmplFn := range templates {
 		log.Printf("Writing %s...", path)
 		contents := strings.TrimSpace(tmplFn(Consts))
-		if err := os.WriteFile(path, []byte(contents), 0644); err != nil {
+		if err := os.WriteFile(path, []byte(contents), 0o644); err != nil {
 			return fmt.Errorf("error writing version file: %w", err)
 		}
 	}

examples/python/django/datastar/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for datastar project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "datastar.settings")
+
+application = get_asgi_application()

examples/python/django/datastar/settings.py

@@ -0,0 +1,123 @@
+"""
+Django settings for datastar project.
+
+Generated by 'django-admin startproject' using Django 4.2.16.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.2/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-_=(hbyv-s)mgn*5d!0wmq#-dd7wq4v6200+^5anv+5lt_8sp*)"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "datastar.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "datastar.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/4.2/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/4.2/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.2/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

examples/python/django/datastar/urls.py

@@ -0,0 +1,26 @@
+"""
+URL configuration for datastar project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+
+from django.contrib import admin
+from django.urls import path
+from ds import views
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+    path("", views.home),
+    path("updates", views.updates),
+]

examples/python/django/datastar/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for datastar project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "datastar.settings")
+
+application = get_wsgi_application()

examples/python/django/ds/admin.py

@@ -0,0 +1 @@
+# Register your models here.

examples/python/django/ds/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class DsConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "ds"

examples/python/django/ds/models.py

@@ -0,0 +1 @@
+# Create your models here.

examples/python/django/ds/tests.py

@@ -0,0 +1 @@
+# Create your tests here.

examples/python/django/ds/views.py

@@ -0,0 +1,59 @@
+import asyncio
+from datetime import datetime
+
+from django.http import HttpResponse
+
+from datastar_py.responses import DatastarDjangoResponse
+
+HTML = """\
+	<!DOCTYPE html>
+	<html lang="en">
+		<head>
+			<title>DATASTAR on Django</title>
+			<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
+            <script type="module" src="https://cdn.jsdelivr.net/gh/starfederation/datastar/bundles/datastar.js"></script>
+			<style>
+            html, body { height: 100%; width: 100%; }
+            body { background-image: linear-gradient(to right bottom, oklch(0.424958 0.052808 253.972015), oklch(0.189627 0.038744 264.832977)); }
+            .container { display: grid; place-content: center; }
+            .time { padding: 2rem; border-radius: 8px; margin-top: 3rem; font-family: monospace, sans-serif; background-color: oklch(0.916374 0.034554 90.5157); color: oklch(0.265104 0.006243 0.522862 / 0.6); font-weight: 600; }
+			</style>
+		</head>
+		<body
+            data-signals="{currentTime: 'CURRENT_TIME'}"
+		>
+        <div class="container">
+            <div
+            class="time"
+            data-on-load="@get('/updates')"
+            >
+            Current time from fragment: <span id="currentTime">CURRENT_TIME</span>
+            </div>
+            <div
+            class="time"
+            >
+            Current time from signal: <span data-text="$currentTime">CURRENT_TIME</span>
+            </div>
+        </div>
+		</body>
+	</html>
+"""
+
+
+async def home(request):
+    return HttpResponse(
+        HTML.replace("CURRENT_TIME", f"{datetime.isoformat(datetime.now())}")
+    )
+
+
+async def updates(request):
+    async def time_updates(sse):
+        while True:
+            yield sse.merge_fragments(
+                [f"""<span id="currentTime">{datetime.now().isoformat()}"""]
+            )
+            await asyncio.sleep(1)
+            yield sse.merge_signals({"currentTime": f"{datetime.now().isoformat()}"})
+            await asyncio.sleep(1)
+
+    return DatastarDjangoResponse(time_updates)

examples/python/django/manage.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "datastar.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()