contextbase-plugin-workflowy 0.2.3__py3-none-any.whl

contextbase_plugin_workflowy-0.2.3.dist-info/METADATA

@@ -0,0 +1,12 @@
+Metadata-Version: 2.3
+Name: contextbase-plugin-workflowy
+Version: 0.2.3
+Summary: Workflowy plugin for ContextBase
+Author: Alizain Feerasta
+Author-email: Alizain Feerasta <alizain.feerasta@gmail.com>
+Requires-Dist: contextbase-shared-plugins==0.2.3
+Requires-Dist: dagster==1.12.14
+Requires-Dist: dagster-dlt==0.28.14
+Requires-Dist: dlt>=1.26.0
+Requires-Dist: pydantic>=2.12.0
+Requires-Python: >=3.14, <3.15

contextbase_plugin_workflowy-0.2.3.dist-info/RECORD

@@ -0,0 +1,15 @@
+plugin_workflowy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plugin_workflowy/binding_config.py,sha256=asvUwjEKy1SEizvIenPckWIhRuTMwqIhgxjwif46ozs,160
+plugin_workflowy/component.py,sha256=oB9mnQydO9CrZSK6QKzbQiAy7THzf20Ejq65RivgAbQ,3584
+plugin_workflowy/defs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plugin_workflowy/defs/defs.yaml,sha256=RFaHPrv3Xo84AZsLb18TrDEOLfpKMsX7axl-oRrYaT4,56
+plugin_workflowy/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plugin_workflowy/models/ctx.py,sha256=BcRgt9VDa6JojYHO0Bnn0Ql-XOxgdXez9RwE_P3QyJM,543
+plugin_workflowy/models/ingress.py,sha256=pb_hXjJaslOFE3WrNx-iA6At5PEN7XT6Ufyzemaa2R0,1477
+plugin_workflowy/models/translators.py,sha256=QKlStO_VP9lqJ73bq70maJl5VHtOU8Ok6tB6Dylmp0s,3228
+plugin_workflowy/plugin.json,sha256=QLcgMi80sLJy2UbjY7w96GQ3hXV1roRICFYgoyWIWA0,85
+plugin_workflowy/sources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plugin_workflowy/sources/snapshot.py,sha256=VHLh-84QLtWgQlyjrmjygs168a8UqJjtCSWHseg1kjY,4337
+contextbase_plugin_workflowy-0.2.3.dist-info/WHEEL,sha256=i9aSRDivn5iP9LaR1BLQX2GNAuriQWPsFwbbWygTX2k,81
+contextbase_plugin_workflowy-0.2.3.dist-info/METADATA,sha256=X1ITkMjM3yjgF1-TTTOY4fr3W1RjW1Z2JS5VSAce3oQ,406
+contextbase_plugin_workflowy-0.2.3.dist-info/RECORD,,

contextbase_plugin_workflowy-0.2.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.11.15
+Root-Is-Purelib: true
+Tag: py3-none-any

plugin_workflowy/binding_config.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from shared_plugins.bindings import BaseBindingConfigModel
+
+
+class WorkflowyBindingConfig(BaseBindingConfigModel):
+    pass

plugin_workflowy/component.py

@@ -0,0 +1,104 @@
+import dagster as dg
+from dagster import AssetExecutionContext
+from dagster_dlt import DagsterDltResource
+from shared_plugins.automation import non_overlapping_automation_condition
+from shared_plugins.bindings import (
+    parse_binding_config,
+    require_api_key,
+)
+from shared_plugins.control_plane import ControlPlaneClient
+from shared_plugins.dlt import resolve_partition_binding, run_dlt_pipeline
+from shared_plugins.naming import (
+    dagster_asset_group_name,
+    dagster_asset_tags,
+    dagster_dlt_asset_key,
+    dagster_partition_def_name,
+    dagster_pool_name,
+    dlt_source_name,
+    plugin_id_from_module,
+)
+from shared_plugins.resources import DLT_RESOURCE
+
+from .binding_config import WorkflowyBindingConfig
+from .sources.snapshot import workflowy_snapshot_source
+
+PLUGIN_ID = plugin_id_from_module(__file__)
+SNAPSHOT_JOB = "snapshot"
+SNAPSHOT_SOURCE_NAME = dlt_source_name(PLUGIN_ID, SNAPSHOT_JOB)
+SNAPSHOT_NODES_ASSET_KEY = dagster_dlt_asset_key(SNAPSHOT_SOURCE_NAME, "nodes")
+
+
+def _build_snapshot_specs(
+    partitions_def: dg.PartitionsDefinition,
+    automation_condition: dg.AutomationCondition,
+) -> list[dg.AssetSpec]:
+    return [
+        dg.AssetSpec(
+            key=SNAPSHOT_NODES_ASSET_KEY,
+            group_name=dagster_asset_group_name(PLUGIN_ID),
+            tags=dagster_asset_tags(PLUGIN_ID),
+            automation_condition=automation_condition,
+            partitions_def=partitions_def,
+        )
+    ]
+
+
+class WorkflowySyncComponent(dg.Component):
+    def build_defs(self, context: dg.ComponentLoadContext) -> dg.Definitions:
+        partitions_def = dg.DynamicPartitionsDefinition(
+            name=dagster_partition_def_name(PLUGIN_ID)
+        )
+        snapshot_specs = _build_snapshot_specs(
+            partitions_def,
+            non_overlapping_automation_condition(
+                dg.AutomationCondition.on_missing()
+                | dg.AutomationCondition.on_cron("*/15 * * * *")
+            ),
+        )
+
+        @dg.multi_asset(
+            specs=snapshot_specs,
+            can_subset=True,
+            name="workflowy_snapshot",
+            pool=dagster_pool_name(PLUGIN_ID),
+        )
+        def workflowy_snapshot_assets(
+            context: AssetExecutionContext,
+            dlt_resource: DagsterDltResource,
+            control_plane: dg.ResourceParam[ControlPlaneClient],
+        ):
+            binding = resolve_partition_binding(
+                context=context,
+                control_plane=control_plane,
+                plugin_id=PLUGIN_ID,
+            )
+            binding_id = str(binding.binding_id)
+            parse_binding_config(binding, WorkflowyBindingConfig)
+
+            source = workflowy_snapshot_source(
+                binding_id,
+                api_key=require_api_key(binding).api_key,
+            )
+            yield from run_dlt_pipeline(
+                context=context,
+                dlt_resource=dlt_resource,
+                source=source,
+                plugin_id=PLUGIN_ID,
+                binding_id=binding_id,
+                job_name=SNAPSHOT_JOB,
+            )
+
+        automation_sensor = dg.AutomationConditionSensorDefinition(
+            name="workflowy_automation_sensor",
+            target=dg.AssetSelection.assets(workflowy_snapshot_assets),
+            default_status=dg.DefaultSensorStatus.RUNNING,
+            minimum_interval_seconds=30,
+        )
+
+        return dg.Definitions(
+            assets=[workflowy_snapshot_assets],
+            sensors=[automation_sensor],
+            resources={
+                "dlt_resource": DLT_RESOURCE,
+            },
+        )

plugin_workflowy/defs/defs.yaml

@@ -0,0 +1 @@
+type: plugin_workflowy.component.WorkflowySyncComponent

plugin_workflowy/models/ctx.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import AwareDatetime
+from shared_plugins.models import CtxModel, IdStr
+
+
+class WorkflowyNodeRow(CtxModel):
+    id: IdStr
+    name: str = ""
+    note: str | None = None
+    parent_id: str | None = None
+    depth: int = 0
+    breadcrumb: str = ""
+    created_at: AwareDatetime | None = None
+    modified_at: AwareDatetime | None = None
+    completed_at: AwareDatetime | None = None
+    completed: bool = False
+    priority: int = 0
+    data: dict[str, Any] | None = None

plugin_workflowy/models/ingress.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+
+from pydantic import (
+    AwareDatetime,
+    AliasChoices,
+    Field,
+    model_validator,
+)
+from shared_plugins.models import IdStr, IngressModel
+
+
+class WorkflowyNodeIngress(IngressModel):
+    id: IdStr
+
+    name: str = Field(default="", strict=True)
+    note: str | None = None
+    parent_id: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices(
+            "parent_id", "parentId", "parentID", "parent", "parent-id"
+        ),
+    )
+    priority: int = Field(
+        default=0,
+        strict=True,
+        validation_alias=AliasChoices("priority", "priority_id", "priorityId"),
+    )
+    created_at: AwareDatetime | None = Field(
+        default=None,
+        validation_alias=AliasChoices("createdAt", "created_at"),
+    )
+    modified_at: AwareDatetime | None = Field(
+        default=None,
+        validation_alias=AliasChoices("modifiedAt", "modified_at"),
+    )
+    completed_at: AwareDatetime | None = Field(
+        default=None,
+        validation_alias=AliasChoices("completedAt", "completed_at"),
+    )
+    completed: bool = Field(
+        default=False,
+        strict=True,
+        validation_alias=AliasChoices("completed", "is_completed", "isCompleted"),
+    )
+    data: dict[str, object] | None = None
+
+    @model_validator(mode="after")
+    def _derive_completed(self) -> WorkflowyNodeIngress:
+        if self.completed_at is not None:
+            self.completed = True
+        return self

plugin_workflowy/models/translators.py

@@ -0,0 +1,112 @@
+from __future__ import annotations
+
+from collections import defaultdict
+from collections.abc import Iterable, Iterator
+
+from .ctx import WorkflowyNodeRow
+from .ingress import WorkflowyNodeIngress
+
+# Keep these as module constants so behavior is explicit and easy to adjust.
+INCLUDE_COMPLETED = True
+BREADCRUMB_SEGMENT_MAX_LEN = 100
+BREADCRUMB_SEPARATOR = " > "
+
+
+def _completed_subtree_ids(
+    nodes: list[WorkflowyNodeIngress],
+) -> set[str]:
+    """Return IDs of all completed nodes and every descendant beneath them."""
+    completed_ids = {n.id for n in nodes if n.completed}
+    if not completed_ids:
+        return set()
+
+    children_of: dict[str | None, list[str]] = defaultdict(list)
+    for n in nodes:
+        children_of[n.parent_id].append(n.id)
+
+    excluded: set[str] = set()
+    stack = list(completed_ids)
+    while stack:
+        node_id = stack.pop()
+        if node_id in excluded:
+            continue
+        excluded.add(node_id)
+        stack.extend(children_of.get(node_id, ()))
+
+    return excluded
+
+
+def _truncate(text: str, max_len: int) -> str:
+    if len(text) <= max_len:
+        return text
+    return text[: max_len - 1] + "\u2026"
+
+
+def _compute_tree_attrs(
+    nodes_by_id: dict[str, WorkflowyNodeIngress],
+) -> dict[str, tuple[int, str]]:
+    """Compute (depth, breadcrumb) for every node. Caches results to avoid
+    repeated ancestor walks."""
+    cache: dict[str, tuple[int, str]] = {}
+
+    def resolve(node_id: str) -> tuple[int, str]:
+        if node_id in cache:
+            return cache[node_id]
+
+        node = nodes_by_id[node_id]
+        segment = _truncate(node.name, BREADCRUMB_SEGMENT_MAX_LEN)
+
+        if node.parent_id is None or node.parent_id not in nodes_by_id:
+            result = (0, segment)
+        else:
+            parent_depth, parent_breadcrumb = resolve(node.parent_id)
+            result = (
+                parent_depth + 1,
+                parent_breadcrumb + BREADCRUMB_SEPARATOR + segment,
+            )
+
+        cache[node_id] = result
+        return result
+
+    for node_id in nodes_by_id:
+        resolve(node_id)
+
+    return cache
+
+
+def workflowy_nodes_to_ctx_models(
+    *,
+    binding_id: str,
+    nodes: Iterable[WorkflowyNodeIngress],
+    include_completed: bool = INCLUDE_COMPLETED,
+) -> Iterator[WorkflowyNodeRow]:
+    all_nodes = list(nodes)
+
+    if include_completed:
+        excluded: set[str] = set()
+    else:
+        excluded = _completed_subtree_ids(all_nodes)
+
+    live_nodes = [n for n in all_nodes if n.id not in excluded]
+    nodes_by_id = {n.id: n for n in live_nodes}
+    tree_attrs = _compute_tree_attrs(nodes_by_id)
+
+    for node in live_nodes:
+        depth, breadcrumb = tree_attrs[node.id]
+
+        yield WorkflowyNodeRow(
+            ctx_binding_id=binding_id,
+            ctx_source_updated_at=node.modified_at,
+            id=node.id,
+            name=node.name,
+            note=node.note,
+            parent_id=node.parent_id,
+            depth=depth,
+            breadcrumb=breadcrumb,
+            created_at=node.created_at,
+            modified_at=node.modified_at,
+            completed_at=node.completed_at,
+            completed=node.completed,
+            priority=node.priority,
+            data=node.data,
+        )

plugin_workflowy/plugin.json

@@ -0,0 +1,7 @@
+{
+	"auth": {
+		"type": "api_key"
+	},
+	"mode": "dagster",
+	"plugin_id": "workflowy"
+}

plugin_workflowy/sources/snapshot.py

@@ -0,0 +1,138 @@
+from __future__ import annotations
+
+import json
+from collections.abc import Iterable
+from collections.abc import Iterator
+from collections.abc import Mapping
+from typing import Any
+
+import dlt
+from dlt.sources.rest_api import rest_api_resources
+from requests import Response
+from shared_plugins.naming import (
+    dlt_resource_name,
+    dlt_source_name,
+    plugin_id_from_module,
+)
+from shared_plugins.resources import ctx_dlt_resource
+
+from ..models.ctx import WorkflowyNodeRow
+from ..models.ingress import WorkflowyNodeIngress
+from ..models.translators import workflowy_nodes_to_ctx_models
+
+PLUGIN_ID = plugin_id_from_module(__file__)
+JOB = "snapshot"
+WORKFLOWY_BASE_URL = "https://beta.workflowy.com/api/v1"
+WORKFLOWY_EXPORT_PATH = "nodes-export"
+DEFAULT_API_KEY_HEADER = "X-Workflowy-Api-Key"
+
+
+def _extract_nodes_from_export_payload(payload: object) -> list[Mapping[str, Any]]:
+    if isinstance(payload, list):
+        raw_nodes = payload
+    elif isinstance(payload, dict):
+        if isinstance(payload.get("items"), list):
+            raw_nodes = payload["items"]
+        elif isinstance(payload.get("nodes"), list):
+            raw_nodes = payload["nodes"]
+        elif isinstance(payload.get("data"), list):
+            raw_nodes = payload["data"]
+        else:
+            raise RuntimeError(
+                "Workflowy export response did not include a nodes list under items/nodes/data."
+            )
+    else:
+        raise RuntimeError(
+            "Workflowy export response was neither a JSON array nor object."
+        )
+
+    extracted: list[Mapping[str, Any]] = []
+    for entry in raw_nodes:
+        if not isinstance(entry, Mapping):
+            raise RuntimeError(
+                "Workflowy export nodes list contained a non-object entry."
+            )
+        extracted.append(entry)
+    return extracted
+
+
+def _canonicalize_workflowy_export_response(
+    response: Response,
+    *args: object,
+    **kwargs: object,
+) -> None:
+    if response.status_code >= 400:
+        return
+
+    try:
+        payload = response.json()
+    except ValueError as exc:
+        raise RuntimeError("Workflowy export returned invalid JSON.") from exc
+
+    nodes = _extract_nodes_from_export_payload(payload)
+    response._content = json.dumps({"nodes": nodes}).encode("utf-8")
+
+
+def build_workflowy_export_nodes_resource(*, api_key: str) -> Any:
+    normalized_api_key = api_key.strip()
+    if not normalized_api_key:
+        raise RuntimeError("Workflowy API key cannot be empty.")
+
+    return rest_api_resources(
+        {
+            "client": {
+                "base_url": WORKFLOWY_BASE_URL,
+                "auth": {
+                    "type": "bearer",
+                    "token": normalized_api_key,
+                },
+                "headers": {
+                    "Accept": "application/json",
+                    DEFAULT_API_KEY_HEADER: normalized_api_key,
+                },
+            },
+            "resources": [
+                {
+                    "name": "workflowy_export_nodes",
+                    "selected": False,
+                    "endpoint": {
+                        "path": WORKFLOWY_EXPORT_PATH,
+                        "method": "GET",
+                        "paginator": "single_page",
+                        "data_selector": "nodes",
+                        "response_actions": [_canonicalize_workflowy_export_response],
+                    },
+                }
+            ],
+        }
+    )[0]
+
+
+def _ingress_nodes_from_raw(
+    raw_nodes: Iterable[Mapping[str, Any]],
+) -> Iterator[WorkflowyNodeIngress]:
+    for raw_node in raw_nodes:
+        yield WorkflowyNodeIngress.model_validate(raw_node)
+
+
+@dlt.source(name=dlt_source_name(PLUGIN_ID, JOB))
+def workflowy_snapshot_source(
+    binding_id: str,
+    *,
+    api_key: str,
+) -> tuple[Any, ...]:
+    raw_nodes_resource = build_workflowy_export_nodes_resource(api_key=api_key)
+
+    @ctx_dlt_resource(
+        name=dlt_resource_name("nodes"),
+        write_disposition="merge",
+        primary_key=("_ctx_binding_id", "id"),
+    )
+    def workflowy_nodes_resource() -> Iterator[WorkflowyNodeRow]:
+        ingress_nodes = _ingress_nodes_from_raw(raw_nodes_resource)
+        yield from workflowy_nodes_to_ctx_models(
+            binding_id=binding_id,
+            nodes=ingress_nodes,
+        )
+
+    return (workflowy_nodes_resource,)