phlo-observatory-example 0.1.1__tar.gz

phlo_observatory_example-0.1.1/.gitignore

@@ -0,0 +1,168 @@
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# 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
+MANIFEST
+.pytest_cache/
+.coverage
+htmlcov/
+*.cover
+.hypothesis/
+.mypy_cache/
+.ruff_cache/
+.pytype/
+*.pyc
+.cache/
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv
+
+# Git worktrees
+.worktrees/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Dagster
+dagster/.nux/
+dagster/.telemetry/
+dagster/__pycache__/
+dagster/history/
+dagster/.logs_queue/
+dagster/schedules/schedules.db
+dagster/schedules/*.db
+dagster/storage/
+dagster/tmpfiles/
+dagster_home/
+
+# dbt
+transforms/dbt/target/
+transforms/dbt/dbt_packages/
+transforms/dbt/logs/
+transforms/dbt/profiles/profiles.yml.bak
+transforms/dbt/package-lock.yml
+
+# Data directories
+volumes/
+*.duckdb
+*.duckdb.wal
+
+# Great Expectations
+great_expectations/uncommitted/
+great_expectations/.ge_store_backend_id
+great_expectations/**/.ge_store_backend_id
+great_expectations/validations/
+
+# Docker
+docker-compose.override.yml
+
+# Logs
+*.log
+logs/
+
+# Temporary files
+*.tmp
+*.temp
+.cache/
+
+# Data files and formats
+*.parquet
+*.csv
+*.pkl
+*.pickle
+*.h5
+*.hdf5
+*.feather
+
+# Cloud and infrastructure
+.aws/
+.gcp/
+.azure/
+.terraform/
+*.tfstate
+*.tfvars
+
+# Jupyter notebooks (if not wanted)
+# *.ipynb
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# IDE and editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.project
+.classpath
+.settings/
+
+# Logs and temporary files
+*.log
+logs/
+*.tmp
+*.temp
+.cache/
+
+transforms/dbt/target
+specs
+PLATFORM_REVIEW.md
+
+# Temporary/working files
+# context/
+context/
+
+# Beads issue tracker (local-only files)
+.beads/beads.db
+.beads/beads.db-*
+.beads/bd.sock
+.beads/bd.pipe
+.beads/.exclusive-lock
+.beads/daemon.*
+.git/beads-worktrees/
+
+# bv (beads viewer) local config and caches
+.bv/
+
+# phlo local config and caches
+.phlo/
+
+.claude
+.ralph/

phlo_observatory_example-0.1.1/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: phlo-observatory-example
+Version: 0.1.1
+Summary: Example Observatory extension plugin
+Author-email: Phlo Team <team@phlo.dev>
+License: MIT
+Requires-Python: >=3.11
+Requires-Dist: phlo-observatory>=0.1.0
+Requires-Dist: phlo>=0.1.0
+Description-Content-Type: text/markdown
+
+# phlo-observatory-example
+
+Example Observatory extension plugin for Phlo.
+
+## What It Shows
+
+- Extension manifest wiring for routes, nav items, dashboard slots, and settings.
+- Static frontend asset packaging from `observatory_assets/`.
+- Plugin registration through `phlo.plugins.observatory`.
+
+## Entry Point
+
+- `example = "phlo_observatory_example.observatory_plugin:ExampleObservatoryExtension"`

phlo_observatory_example-0.1.1/README.md

@@ -0,0 +1,13 @@
+# phlo-observatory-example
+
+Example Observatory extension plugin for Phlo.
+
+## What It Shows
+
+- Extension manifest wiring for routes, nav items, dashboard slots, and settings.
+- Static frontend asset packaging from `observatory_assets/`.
+- Plugin registration through `phlo.plugins.observatory`.
+
+## Entry Point
+
+- `example = "phlo_observatory_example.observatory_plugin:ExampleObservatoryExtension"`

phlo_observatory_example-0.1.1/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "phlo-observatory-example"
+version = "0.1.1"
+description = "Example Observatory extension plugin"
+readme = "README.md"
+requires-python = ">=3.11"
+authors = [
+    {name = "Phlo Team", email = "team@phlo.dev"},
+]
+license = {text = "MIT"}
+dependencies = [
+    "phlo>=0.1.0",
+    "phlo-observatory>=0.1.0",
+]
+
+[project.entry-points."phlo.plugins.observatory"]
+example = "phlo_observatory_example.observatory_plugin:ExampleObservatoryExtension"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/phlo_observatory_example"]
+include = ["src/phlo_observatory_example/observatory_assets/*"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/phlo_observatory_example"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"

phlo_observatory_example-0.1.1/src/phlo_observatory_example/__init__.py

@@ -0,0 +1 @@
+"""Example Observatory extension package."""

phlo_observatory_example-0.1.1/src/phlo_observatory_example/observatory_assets/README.txt

@@ -0,0 +1 @@
+Observatory assets for phlo-observatory-example.

phlo_observatory_example-0.1.1/src/phlo_observatory_example/observatory_assets/example.js

@@ -0,0 +1,141 @@
+export function registerRoutes({ createRoute, rootRoute }) {
+  return createRoute({
+    getParentRoute: () => rootRoute,
+    path: '/extensions/example',
+    component: ExamplePage,
+  })
+}
+
+export function registerDashboardSlot({ register }) {
+  register(DashboardNote)
+}
+
+export function registerHubSlot({ register }) {
+  register(HubNote)
+}
+
+const settingsApi = { loadSettings: null, saveSettings: null }
+
+export function registerSettings({ register, loadSettings, saveSettings }) {
+  settingsApi.loadSettings = loadSettings
+  settingsApi.saveSettings = saveSettings
+  register({
+    id: 'example-settings',
+    title: 'Example Extension',
+    description: 'Demonstrates extension settings panels.',
+    component: ExampleSettings,
+  })
+}
+
+function ExamplePage() {
+  return 'Example extension route loaded.'
+}
+
+function DashboardNote() {
+  return 'Extension slot: dashboard.after-cards.'
+}
+
+function HubNote() {
+  return 'Extension slot: hub.after-stats.'
+}
+
+function ExampleSettings() {
+  const React = typeof globalThis !== 'undefined' ? globalThis.__phloReact : null
+  if (!React) return 'React is not available for extension settings.'
+
+  const { useEffect, useState } = React
+  const el = React.createElement
+  const loadSettingsFn = settingsApi.loadSettings
+  const saveSettingsFn = settingsApi.saveSettings
+  if (!loadSettingsFn || !saveSettingsFn) {
+    return 'Settings API is not available for this extension.'
+  }
+  const [loading, setLoading] = useState(true)
+  const [message, setMessage] = useState('')
+  const [enabled, setEnabled] = useState(false)
+  const [status, setStatus] = useState(null)
+
+  useEffect(() => {
+    let active = true
+    loadSettingsFn()
+      .then((data) => {
+        if (!active) return
+        setEnabled(Boolean(data.enabled))
+        setMessage(typeof data.message === 'string' ? data.message : '')
+        setLoading(false)
+      })
+      .catch(() => {
+        if (!active) return
+        setStatus('Failed to load settings.')
+        setLoading(false)
+      })
+    return () => {
+      active = false
+    }
+  }, [loadSettingsFn])
+
+  const handleSave = async () => {
+    setStatus(null)
+    try {
+      await saveSettingsFn({ enabled, message })
+      setStatus('Saved.')
+    } catch {
+      setStatus('Save failed.')
+    }
+  }
+
+  if (loading) return 'Loading settings...'
+
+  return el(
+    'div',
+    { className: 'space-y-3' },
+    el(
+      'div',
+      { className: 'space-y-2' },
+      el(
+        'label',
+        {
+          className: 'text-sm font-medium',
+          htmlFor: 'example-settings-message',
+        },
+        'Message',
+      ),
+      el('input', {
+        id: 'example-settings-message',
+        className:
+          'w-full rounded-md border border-input bg-background px-3 py-2 text-sm',
+        placeholder: 'Message',
+        value: message,
+        onChange: (event) => setMessage(event.target.value),
+      }),
+    ),
+    el(
+      'label',
+      { className: 'flex items-center gap-2 text-sm' },
+      el('input', {
+        type: 'checkbox',
+        className: 'h-4 w-4',
+        checked: enabled,
+        onChange: (event) => setEnabled(event.target.checked),
+      }),
+      'Enabled',
+    ),
+    el(
+      'div',
+      { className: 'flex items-center gap-2' },
+      el(
+        'button',
+        {
+          type: 'button',
+          className:
+            'inline-flex items-center rounded-md bg-primary px-3 py-2 text-sm font-medium text-primary-foreground shadow-sm',
+          onClick: handleSave,
+        },
+        'Save',
+      ),
+      status
+        ? el('span', { className: 'text-sm text-muted-foreground' }, status)
+        : null,
+    ),
+  )
+}

phlo_observatory_example-0.1.1/src/phlo_observatory_example/observatory_plugin.py

@@ -0,0 +1,81 @@
+"""Example Observatory extension plugin."""
+
+from __future__ import annotations
+
+from importlib import resources
+from importlib.abc import Traversable
+
+from phlo.plugins import PluginMetadata
+from phlo_observatory import ObservatoryExtensionPlugin
+from phlo_observatory.manifest import (
+    ObservatoryExtensionCompatibility,
+    ObservatoryExtensionManifest,
+    ObservatoryExtensionNavItem,
+    ObservatoryExtensionRoute,
+    ObservatoryExtensionSettings,
+    ObservatoryExtensionSettingsPanel,
+    ObservatoryExtensionSlot,
+    ObservatoryExtensionUI,
+)
+
+
+class ExampleObservatoryExtension(ObservatoryExtensionPlugin):
+    """Example Observatory extension showing routes, slots, and settings panels."""
+
+    @property
+    def metadata(self) -> PluginMetadata:
+        return PluginMetadata(
+            name="example",
+            version="0.1.0",
+            description="Example Observatory UI extension",
+        )
+
+    @property
+    def manifest(self) -> ObservatoryExtensionManifest:
+        return ObservatoryExtensionManifest(
+            name="example",
+            version="0.1.0",
+            compat=ObservatoryExtensionCompatibility(observatory_min="0.1.0"),
+            settings=ObservatoryExtensionSettings(
+                settings_schema={
+                    "type": "object",
+                    "properties": {
+                        "enabled": {"type": "boolean"},
+                        "message": {"type": "string"},
+                    },
+                },
+                defaults={"enabled": True, "message": "Hello from extension settings."},
+                scope="extension",
+            ),
+            ui=ObservatoryExtensionUI(
+                routes=[
+                    ObservatoryExtensionRoute(
+                        path="/extensions/example",
+                        module="/example.js",
+                        export="registerRoutes",
+                    )
+                ],
+                nav=[ObservatoryExtensionNavItem(title="Example", to="/extensions/example")],
+                slots=[
+                    ObservatoryExtensionSlot(
+                        slot_id="dashboard.after-cards",
+                        module="/example.js",
+                        export="registerDashboardSlot",
+                    ),
+                    ObservatoryExtensionSlot(
+                        slot_id="hub.after-stats",
+                        module="/example.js",
+                        export="registerHubSlot",
+                    ),
+                ],
+                settings=[
+                    ObservatoryExtensionSettingsPanel(
+                        module="/example.js", export="registerSettings"
+                    )
+                ],
+            ),
+        )
+
+    @property
+    def asset_root(self) -> Traversable:
+        return resources.files("phlo_observatory_example").joinpath("observatory_assets")