tangram-system 0.2.1__py3-none-any.whl

tangram_system/SystemWidget.vue

@@ -0,0 +1,83 @@
+<template>
+  <div class="system-widget">
+    <div
+      class="clock"
+      @mouseover="state.hovered = true"
+      @mouseleave="state.hovered = false"
+    >
+      <span id="info_time">{{ state.hovered ? local_time : utc_time }}</span>
+    </div>
+    <span id="uptime">{{ state.uptime }}</span>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { reactive, computed, inject, onMounted, onUnmounted } from "vue";
+import type { TangramApi, Disposable } from "@open-aviation/tangram-core/api";
+
+const tangramApi = inject<TangramApi>("tangramApi");
+if (!tangramApi) {
+  throw new Error("assert: tangram api not provided");
+}
+
+const state = reactive({
+  hovered: false,
+  uptime: "",
+  info_utc: new Date().getTime()
+});
+
+let subscription: Disposable | null = null;
+
+onMounted(async () => {
+  try {
+    subscription = await tangramApi.realtime.subscribe(
+      "system:update-node",
+      (payload: { el: string; value: string | number }) => {
+        if (payload.el === "uptime") state.uptime = payload.value as string;
+        if (payload.el === "info_utc") state.info_utc = payload.value as number;
+      }
+    );
+  } catch (e) {
+    console.error("failed to subscribe to system:update-node", e);
+  }
+});
+
+onUnmounted(() => {
+  subscription?.dispose();
+});
+
+const utc_time = computed(() => {
+  const date = new Date(state.info_utc);
+  const hours = date.getUTCHours().toString().padStart(2, "0");
+  const minutes = date.getUTCMinutes().toString().padStart(2, "0");
+  const seconds = date.getUTCSeconds().toString().padStart(2, "0");
+  return `${hours}:${minutes}:${seconds} Z`;
+});
+
+const local_time = computed(() => {
+  const date = new Date(state.info_utc);
+  return date.toLocaleTimeString([], {
+    hour: "2-digit",
+    minute: "2-digit",
+    second: "2-digit",
+    hour12: false,
+    timeZoneName: "shortOffset"
+  });
+});
+</script>
+
+<style scoped>
+#uptime {
+  color: #79706e;
+  font-size: 9pt;
+  text-align: center;
+}
+
+.system-widget {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  padding: 1px;
+  border-bottom: 1px solid #ddd;
+}
+</style>

tangram_system/__init__.py

@@ -0,0 +1,81 @@
+import asyncio
+import logging
+from dataclasses import dataclass
+from datetime import datetime, timedelta, timezone
+from typing import Any, NoReturn
+
+import orjson
+import psutil
+import redis.asyncio as redis
+import tangram_core
+
+log = logging.getLogger(__name__)
+
+
+@dataclass
+class SystemConfig(tangram_core.config.HasSidebarUiConfig):
+    topbar_order: int = 0
+
+
+def transform_config(config_dict: dict[str, Any]) -> SystemConfig:
+    from pydantic import TypeAdapter
+
+    return TypeAdapter(SystemConfig).validate_python(config_dict)
+
+
+def uptime(counter: int) -> dict[str, str]:
+    return {
+        "el": "uptime",
+        "value": f"{timedelta(seconds=counter)}",
+    }
+
+
+def info_utc() -> dict[str, str | int]:
+    return {
+        "el": "info_utc",
+        "value": 1000 * int(datetime.now(timezone.utc).timestamp()),
+    }
+
+
+def cpu_load() -> dict[str, str]:
+    try:
+        load1, _load5, _load15 = psutil.getloadavg()
+        cpu_count = psutil.cpu_count(logical=True) or 1
+        load_percent = (load1 / cpu_count) * 100
+        return {"el": "cpu_load", "value": f"{load_percent:.2f}%"}
+    except Exception:
+        return {"el": "cpu_load", "value": "Unavailable"}
+
+
+def ram_usage() -> dict[str, str]:
+    try:
+        mem = psutil.virtual_memory()
+        return {"el": "ram_usage", "value": f"{mem.percent:.2f}%"}
+    except Exception:
+        return {"el": "ram_usage", "value": "Unavailable"}
+
+
+async def server_events(redis_client: redis.Redis) -> NoReturn:
+    counter = 0
+    log.info("serving system events...")
+
+    while True:
+        await redis_client.publish(
+            "to:system:update-node", orjson.dumps(uptime(counter))
+        )
+        await redis_client.publish("to:system:update-node", orjson.dumps(info_utc()))
+        await redis_client.publish("to:system:update-node", orjson.dumps(cpu_load()))
+        await redis_client.publish("to:system:update-node", orjson.dumps(ram_usage()))
+        counter += 1
+
+        await asyncio.sleep(1)
+
+
+plugin = tangram_core.Plugin(
+    frontend_path="dist-frontend", into_frontend_config_function=transform_config
+)
+
+
+@plugin.register_service()
+async def run_system(backend_state: tangram_core.BackendState) -> None:
+    await server_events(backend_state.redis_client)

tangram_system/dist-frontend/index.css

@@ -0,0 +1 @@
+#uptime[data-v-6e31ee8b]{color:#79706e;font-size:9pt;text-align:center}.system-widget[data-v-6e31ee8b]{display:flex;flex-direction:column;align-items:center;padding:1px;border-bottom:1px solid #ddd}

tangram_system/dist-frontend/index.js

@@ -0,0 +1,63 @@
+import { defineComponent as l, inject as _, reactive as g, onMounted as f, onUnmounted as v, computed as u, createElementBlock as S, openBlock as h, createElementVNode as c, toDisplayString as d } from "vue";
+const w = { class: "system-widget" }, y = { id: "info_time" }, b = { id: "uptime" }, T = /* @__PURE__ */ l({
+  __name: "SystemWidget",
+  setup(s) {
+    const o = _("tangramApi");
+    if (!o)
+      throw new Error("assert: tangram api not provided");
+    const e = g({
+      hovered: !1,
+      uptime: "",
+      info_utc: (/* @__PURE__ */ new Date()).getTime()
+    });
+    let i = null;
+    f(async () => {
+      try {
+        i = await o.realtime.subscribe(
+          "system:update-node",
+          (t) => {
+            t.el === "uptime" && (e.uptime = t.value), t.el === "info_utc" && (e.info_utc = t.value);
+          }
+        );
+      } catch (t) {
+        console.error("failed to subscribe to system:update-node", t);
+      }
+    }), v(() => {
+      i?.dispose();
+    });
+    const r = u(() => {
+      const t = new Date(e.info_utc), n = t.getUTCHours().toString().padStart(2, "0"), a = t.getUTCMinutes().toString().padStart(2, "0"), p = t.getUTCSeconds().toString().padStart(2, "0");
+      return `${n}:${a}:${p} Z`;
+    }), m = u(() => new Date(e.info_utc).toLocaleTimeString([], {
+      hour: "2-digit",
+      minute: "2-digit",
+      second: "2-digit",
+      hour12: !1,
+      timeZoneName: "shortOffset"
+    }));
+    return (t, n) => (h(), S("div", w, [
+      c("div", {
+        class: "clock",
+        onMouseover: n[0] || (n[0] = (a) => e.hovered = !0),
+        onMouseleave: n[1] || (n[1] = (a) => e.hovered = !1)
+      }, [
+        c("span", y, d(e.hovered ? m.value : r.value), 1)
+      ], 32),
+      c("span", b, d(e.uptime), 1)
+    ]));
+  }
+}), $ = (s, o) => {
+  const e = s.__vccOpts || s;
+  for (const [i, r] of o)
+    e[i] = r;
+  return e;
+}, k = /* @__PURE__ */ $(T, [["__scopeId", "data-v-6e31ee8b"]]);
+function D(s, o) {
+  s.ui.registerWidget("system-widget", "TopBar", k, {
+    priority: o?.topbar_order
+  });
+}
+export {
+  D as install
+};
+//# sourceMappingURL=index.js.map

tangram_system/dist-frontend/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/tangram_system/SystemWidget.vue","../src/tangram_system/index.ts"],"sourcesContent":["<template>\n  <div class=\"system-widget\">\n    <div\n      class=\"clock\"\n      @mouseover=\"state.hovered = true\"\n      @mouseleave=\"state.hovered = false\"\n    >\n      <span id=\"info_time\">{{ state.hovered ? local_time : utc_time }}</span>\n    </div>\n    <span id=\"uptime\">{{ state.uptime }}</span>\n  </div>\n</template>\n\n<script setup lang=\"ts\">\nimport { reactive, computed, inject, onMounted, onUnmounted } from \"vue\";\nimport type { TangramApi, Disposable } from \"@open-aviation/tangram-core/api\";\n\nconst tangramApi = inject<TangramApi>(\"tangramApi\");\nif (!tangramApi) {\n  throw new Error(\"assert: tangram api not provided\");\n}\n\nconst state = reactive({\n  hovered: false,\n  uptime: \"\",\n  info_utc: new Date().getTime()\n});\n\nlet subscription: Disposable | null = null;\n\nonMounted(async () => {\n  try {\n    subscription = await tangramApi.realtime.subscribe(\n      \"system:update-node\",\n      (payload: { el: string; value: string | number }) => {\n        if (payload.el === \"uptime\") state.uptime = payload.value as string;\n        if (payload.el === \"info_utc\") state.info_utc = payload.value as number;\n      }\n    );\n  } catch (e) {\n    console.error(\"failed to subscribe to system:update-node\", e);\n  }\n});\n\nonUnmounted(() => {\n  subscription?.dispose();\n});\n\nconst utc_time = computed(() => {\n  const date = new Date(state.info_utc);\n  const hours = date.getUTCHours().toString().padStart(2, \"0\");\n  const minutes = date.getUTCMinutes().toString().padStart(2, \"0\");\n  const seconds = date.getUTCSeconds().toString().padStart(2, \"0\");\n  return `${hours}:${minutes}:${seconds} Z`;\n});\n\nconst local_time = computed(() => {\n  const date = new Date(state.info_utc);\n  return date.toLocaleTimeString([], {\n    hour: \"2-digit\",\n    minute: \"2-digit\",\n    second: \"2-digit\",\n    hour12: false,\n    timeZoneName: \"shortOffset\"\n  });\n});\n</script>\n\n<style scoped>\n#uptime {\n  color: #79706e;\n  font-size: 9pt;\n  text-align: center;\n}\n\n.system-widget {\n  display: flex;\n  flex-direction: column;\n  align-items: center;\n  padding: 1px;\n  border-bottom: 1px solid #ddd;\n}\n</style>\n","import type { TangramApi } from \"@open-aviation/tangram-core/api\";\nimport SystemWidget from \"./SystemWidget.vue\";\n\ninterface SystemConfig {\n  topbar_order: number;\n}\n\nexport function install(api: TangramApi, config?: SystemConfig) {\n  api.ui.registerWidget(\"system-widget\", \"TopBar\", SystemWidget, {\n    priority: config?.topbar_order\n  });\n}\n"],"names":["tangramApi","inject","state","reactive","subscription","onMounted","payload","e","onUnmounted","utc_time","computed","date","hours","minutes","seconds","local_time","_openBlock","_createElementBlock","_hoisted_1","_createElementVNode","_cache","$event","_hoisted_2","_toDisplayString","_hoisted_3","install","api","config","SystemWidget"],"mappings":";;;;AAiBA,UAAMA,IAAaC,EAAmB,YAAY;AAClD,QAAI,CAACD;AACH,YAAM,IAAI,MAAM,kCAAkC;AAGpD,UAAME,IAAQC,EAAS;AAAA,MACrB,SAAS;AAAA,MACT,QAAQ;AAAA,MACR,WAAU,oBAAI,KAAA,GAAO,QAAA;AAAA,IAAQ,CAC9B;AAED,QAAIC,IAAkC;AAEtC,IAAAC,EAAU,YAAY;AACpB,UAAI;AACF,QAAAD,IAAe,MAAMJ,EAAW,SAAS;AAAA,UACvC;AAAA,UACA,CAACM,MAAoD;AACnD,YAAIA,EAAQ,OAAO,aAAUJ,EAAM,SAASI,EAAQ,QAChDA,EAAQ,OAAO,eAAYJ,EAAM,WAAWI,EAAQ;AAAA,UAC1D;AAAA,QAAA;AAAA,MAEJ,SAASC,GAAG;AACV,gBAAQ,MAAM,6CAA6CA,CAAC;AAAA,MAC9D;AAAA,IACF,CAAC,GAEDC,EAAY,MAAM;AAChB,MAAAJ,GAAc,QAAA;AAAA,IAChB,CAAC;AAED,UAAMK,IAAWC,EAAS,MAAM;AAC9B,YAAMC,IAAO,IAAI,KAAKT,EAAM,QAAQ,GAC9BU,IAAQD,EAAK,YAAA,EAAc,WAAW,SAAS,GAAG,GAAG,GACrDE,IAAUF,EAAK,cAAA,EAAgB,WAAW,SAAS,GAAG,GAAG,GACzDG,IAAUH,EAAK,cAAA,EAAgB,WAAW,SAAS,GAAG,GAAG;AAC/D,aAAO,GAAGC,CAAK,IAAIC,CAAO,IAAIC,CAAO;AAAA,IACvC,CAAC,GAEKC,IAAaL,EAAS,MACb,IAAI,KAAKR,EAAM,QAAQ,EACxB,mBAAmB,IAAI;AAAA,MACjC,MAAM;AAAA,MACN,QAAQ;AAAA,MACR,QAAQ;AAAA,MACR,QAAQ;AAAA,MACR,cAAc;AAAA,IAAA,CACf,CACF;sBAhECc,EAAA,GAAAC,EASM,OATNC,GASM;AAAA,MARJC,EAMM,OAAA;AAAA,QALJ,OAAM;AAAA,QACL,aAASC,EAAA,CAAA,MAAAA,EAAA,CAAA,IAAA,CAAAC,MAAEnB,EAAM,UAAO;AAAA,QACxB,cAAUkB,EAAA,CAAA,MAAAA,EAAA,CAAA,IAAA,CAAAC,MAAEnB,EAAM,UAAO;AAAA,MAAA;QAE1BiB,EAAuE,QAAvEG,GAAuEC,EAA/CrB,EAAM,UAAUa,EAAA,QAAaN,EAAA,KAAQ,GAAA,CAAA;AAAA,MAAA;MAE/DU,EAA2C,QAA3CK,GAA2CD,EAAtBrB,EAAM,MAAM,GAAA,CAAA;AAAA,IAAA;;;;;;;;ACF9B,SAASuB,EAAQC,GAAiBC,GAAuB;AAC9D,EAAAD,EAAI,GAAG,eAAe,iBAAiB,UAAUE,GAAc;AAAA,IAC7D,UAAUD,GAAQ;AAAA,EAAA,CACnB;AACH;"}

tangram_system/dist-frontend/plugin.json

@@ -0,0 +1,5 @@
+{
+  "name": "@open-aviation/tangram-system",
+  "main": "index.js",
+  "style": "index.css"
+}

tangram_system/index.ts

@@ -0,0 +1,12 @@
+import type { TangramApi } from "@open-aviation/tangram-core/api";
+import SystemWidget from "./SystemWidget.vue";
+
+interface SystemConfig {
+  topbar_order: number;
+}
+
+export function install(api: TangramApi, config?: SystemConfig) {
+  api.ui.registerWidget("system-widget", "TopBar", SystemWidget, {
+    priority: config?.topbar_order
+  });
+}

tangram_system/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@open-aviation/tangram-system",
+  "version": "0.2.1",
+  "private": true,
+  "type": "module",
+  "main": "src/tangram_system/index.ts",
+  "scripts": {
+    "build": "vite build"
+  },
+  "dependencies": {
+    "@open-aviation/tangram-core": "workspace:*"
+  },
+  "devDependencies": {
+    "vue": "^3.5.25"
+  }
+}

tangram_system-0.2.1.dist-info/METADATA

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: tangram_system
+Version: 0.2.1
+Summary: System monitoring plugin for tangram
+Author-email: Xavier Olive <git@xoolive.org>, Junzi Sun <git@junzis.com>
+License-Expression: AGPL-3.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.10
+Requires-Dist: psutil
+Requires-Dist: tangram-core>=0.2.0
+Description-Content-Type: text/markdown
+
+# tangram_system
+
+The `tangram_system` plugin provides system monitoring capabilities for the tangram framework.
+
+It includes a background service that broadcasts server metrics (CPU, RAM, Uptime) to connected frontend clients via the realtime channel.
+
+## About Tangram
+
+`tangram_system` is a plugin for `tangram`, an open framework for modular, real-time air traffic management research.
+
+- Documentation: <https://mode-s.org/tangram/>
+- Repository: <https://github.com/open-aviation/tangram>
+
+Installation:
+
+```sh
+# cli via uv
+uv tool install --with tangram-system tangram-core
+# with pip
+pip install tangram-core tangram-system
+```

tangram_system-0.2.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+tangram_system/SystemWidget.vue,sha256=A1eZIibTmmrCyPdmqtcJi60dArSg4qYw6Mn76Iw2rgE,2069
+tangram_system/__init__.py,sha256=CJqn9VUAirPI8jOXCI1Lk3GR9FIgNhGF6if5yfsR3Wk,2245
+tangram_system/index.ts,sha256=COqiA9ro0jHvdtigahKbZ75SoApJtbV24vaakeNVXKI,343
+tangram_system/dist-frontend/index.css,sha256=Ck5orxty4qPRwI417S1V8NU7Xw606jMQZqdSf0bqgmk,199
+tangram_system/dist-frontend/index.js,sha256=4d3jbhcLv9pwDophIF8UvD6Z8Si3wtTcV5HIh_sEKKk,2108
+tangram_system/dist-frontend/index.js.map,sha256=8HSWZ_rCKEyo8HsqiPCqbGbCyAxvqDTTGjXOmp3R0nw,4529
+tangram_system/dist-frontend/plugin.json,sha256=f9ITIfSjnW0OhcoQa6pp3HgxSLxDszLCLiZ6H2coz9A,91
+tangram_system/package.json,sha256=zT1MUNUIYT1SqAtG8Kq70Gb9To8xT2kHIV4EwoB2MnM,316
+tangram_system-0.2.1.dist-info/METADATA,sha256=m3IlhvIETh0ns9gBzD8VUWCc7AUjQh-tg6IDdJ0Jz1I,1478
+tangram_system-0.2.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+tangram_system-0.2.1.dist-info/entry_points.txt,sha256=lC7Uu8HPLHLg2ULa0lh2SWTN2qt_LrPFUrcqVL4heZk,62
+tangram_system-0.2.1.dist-info/RECORD,,

tangram_system-0.2.1.dist-info/WHEEL

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

tangram_system-0.2.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[tangram_core.plugins]
+tangram_system = tangram_system:plugin