renamed dashi into chartlets

Author: forman

dashi/README.md

@@ -1,6 +1,6 @@
-# dashi 
+# chartlets 
 
-Dashi is a JavaScript library that allows configuring server-side widgets
+Chartlets is a JavaScript library that allows configuring server-side widgets
 and plugging them into existing web frontends.
 
 _Note, this library is experimental and under development still._
@@ -31,23 +31,23 @@ The bottom shows the lifeline of the backend REST server.
 ## How to run the demo
 
 ```bash
-git clone https://github.com/bcdev/dashi.git
+git clone https://github.com/bcdev/chartlets.git
 ```
 
 ### Run the server
 
 ```bash
-cd dashi/dashipy
+cd chartlets/dashipy
 conda env create
-conda activate dashi
+conda activate chartlets
 pip install -ve . 
 python -m dashipy.demo.server
 ```
 
 ### Run the UI
 
 ```bash
-cd ../dashi
+cd ../chartlets
 npm install
 npm run dev
 ```

dashi/TODO.md

@@ -1,4 +1,4 @@
-# Dashi UI TODOs
+# Chartlets UI TODOs
 
 - Keep state flat, avoid deep nesting!
 
@@ -11,7 +11,5 @@
   - How: Go back to former design where initial contributions that stay constant
     are separate from changing contribution states and components.
 
-- Consequently use `propertyPath: string[]` instead of `propertyName: string`  
-
 - Add true actions from `src/actions` to store state so that lib users
   know what actions are public.

dashi/package-lock.json

@@ -1,6 +1,6 @@
 {
-  "name": "dashipopashi",
-  "version": "0.0.15",
+  "name": "chartlets",
+  "version": "0.0.0",
   "description": "An experimental library for integrating interactive charts into existing JavaScript applications.",
   "type": "module",
   "files": [
@@ -18,22 +18,22 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/bcdev/dashi.git"
+    "url": "https://github.com/bcdev/charlet.git"
   },
   "bugs": {
-    "url": "https://github.com/bcdev/dashi/issues"
+    "url": "https://github.com/bcdev/charlet/issues"
   },
-  "homepage": "https://github.com/bcdev/dashi/blob/main/dashi/README.md",
+  "homepage": "https://github.com/bcdev/charlet/blob/main/chartlets/README.md",
   "author": "Brockmann Consult GmbH",
   "license": "MIT",
   "types": "./dist/index.d.ts",
-  "module": "./dist/dashi.js",
-  "main": "./dist/dashi.umd.cjs",
+  "module": "./dist/chartlets.js",
+  "main": "./dist/chartlets.umd.cjs",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "module": "./dist/dashi.js",
-      "require": "./dist/dashi.umd.cjs"
+      "module": "./dist/chartlets.js",
+      "require": "./dist/chartlets.umd.cjs"
     }
   },
   "scripts": {

dashi/package.json

@@ -32,7 +32,7 @@ function App() {
     <ThemeProvider theme={theme}>
       <CssBaseline />
       <Typography fontSize="3em" fontWeight="bold">
-        Dashi Demo
+        Chartlets Demo
       </Typography>
       <ExtensionsInfo />
       <ControlBar />

dashi/src/demo/App.tsx

@@ -27,26 +27,26 @@ function logState(next: StoreState, prev: StoreState) {
   const delta = diff(prev, next);
   const nDiffs = delta.length;
   console.groupCollapsed(
-    `dashi: state changed (${nDiffs} difference${nDiffs === 1 ? "" : "s"})`,
+    `chartlets: state changed (${nDiffs} difference${nDiffs === 1 ? "" : "s"})`,
   );
   delta.forEach(logDiff);
-  console.debug("dashi: change details:", { prev, next, delta });
+  console.debug("chartlets: change details:", { prev, next, delta });
   console.groupEnd();
 }
 
 function logDiff(v: Difference, index: number) {
   const wherePart = `%c${index + 1} %c${v.type} %c${v.path.join(".")}`;
   if (v.type === "CREATE") {
-    console.debug("dashi:", wherePart, indexStyle, typeStyle, pathStyle, {
+    console.debug("chartlets:", wherePart, indexStyle, typeStyle, pathStyle, {
       value: v.value,
     });
   } else if (v.type === "CHANGE") {
-    console.debug("dashi:", wherePart, indexStyle, typeStyle, pathStyle, {
+    console.debug("chartlets:", wherePart, indexStyle, typeStyle, pathStyle, {
       value: v.value,
       oldValue: v.oldValue,
     });
   } else if (v.type === "REMOVE") {
-    console.debug("dashi:", wherePart, indexStyle, typeStyle, pathStyle, {
+    console.debug("chartlets:", wherePart, indexStyle, typeStyle, pathStyle, {
       oldValue: v.oldValue,
     });
   }

dashi/src/lib/actions/helpers/configureLogging.ts

@@ -8,14 +8,17 @@ export function invokeCallbacks(callbackRequests: CallbackRequest[]) {
   const shouldLog = configuration.logging?.enabled;
   if (!callbackRequests.length) {
     if (shouldLog) {
-      console.info(`dashi: invokeCallbacks - no requests`, callbackRequests);
+      console.info(
+        `chartlets: invokeCallbacks - no requests`,
+        callbackRequests,
+      );
     }
     return;
   }
   const invocationId = getInvocationId();
   if (shouldLog) {
     console.info(
-      `dashi: invokeCallbacks (${invocationId})-->`,
+      `chartlets: invokeCallbacks (${invocationId})-->`,
       callbackRequests,
     );
   }
@@ -24,7 +27,7 @@ export function invokeCallbacks(callbackRequests: CallbackRequest[]) {
       if (changeRequestsResult.data) {
         if (shouldLog) {
           console.info(
-            `dashi: invokeCallbacks <--(${invocationId})`,
+            `chartlets: invokeCallbacks <--(${invocationId})`,
             changeRequestsResult.data,
           );
         }

dashi/src/lib/actions/helpers/invokeCallbacks.ts

@@ -2,7 +2,7 @@ import type { ApiOptions, ApiError, ApiResult } from "@/lib/types/api";
 import { hasOwnProperty } from "../utils/hasOwnProperty";
 
 const defaultServerUrl = "http://localhost:8888";
-const defaultEndpointName = "dashi";
+const defaultEndpointName = "chartlets";
 
 export async function fetchApiResult<T, P extends unknown[]>(
   callApi: (...args: P) => Promise<T>,

dashi/src/lib/api/helpers.ts

@@ -39,9 +39,9 @@ export default defineConfig({
     sourcemap: true,
     lib: {
       entry: resolve(__dirname, "src/lib/index.ts"),
-      name: "Dashi",
+      name: "Chartlets",
       // the proper extensions will be added
-      fileName: "dashi",
+      fileName: "chartlets",
     },
     rollupOptions: {
       // externalize deps that shouldn't be bundled into the library

dashi/vite.config.ts

@@ -1,13 +1,13 @@
-# dashi 
+# chartlets 
 
-Dashi is a framework for server-configured panels. 
+`chartlets` is a Python framework for server-configured web-UI contributions. 
 
 ## Run demo server
 
 ``` bash
 mamba env create
-conda activate dashi
-python -m dashipy.server 
+conda activate chartlets
+python -m chartlets.demo.server 
 ```
 
 ## How to use the framework
@@ -17,10 +17,10 @@ python -m dashipy.server
 Implement the application-specific contributions that users 
 can add to their extensions.
 
-As an example, see [`panel.py` of the demo](dashipy/demo/contribs/panel.py):
+As an example, see [`panel.py` of the demo](chartlets/demo/contribs/panel.py):
 
 ```python
-from dashipy import Contribution
+from chartlets import Contribution
 
 
 class Panel(Contribution):
@@ -34,11 +34,11 @@ class Panel(Contribution):
 
 Define the possible contribution points in your application.
 
-As an example, see [`server.py` of the demo](dashipy/demo/server.py):
+As an example, see [`server.py` of the demo](chartlets/demo/server.py):
 
 ```python
-from dashipy import Extension
-from dashipy.demo.contribs import Panel
+from chartlets import Extension
+from chartlets.demo.contribs import Panel
 
 Extension.add_contrib_point("panels", Panel)
 ```
@@ -47,24 +47,24 @@ Extension.add_contrib_point("panels", Panel)
 
 Load the extensions that augment your application.
 
-As an example, see [`server.py` of the demo](dashipy/demo/server.py):
+As an example, see [`server.py` of the demo](chartlets/demo/server.py):
 
 ```python
-from dashipy import ExtensionContext
+from chartlets import ExtensionContext
 
 ext_ctx = ExtensionContext.load(app_ctx, extension_refs)
 ```
 
 ### 4. Publish the extensions 
 
-Implement the Dashi API in your application-specific webserver using
+Implement the Chartlets API in your application-specific webserver using
 the controller implementations in `dashipy.controllers`. 
 
-As an example, see [`server.py` of the demo](dashipy/demo/server.py).
+As an example, see [`server.py` of the demo](chartlets/demo/server.py).
 
 ### 5. Consume the extensions
 
-Use JavaScript package `dashi` in your frontend to implement the 
+Use JavaScript package `chartlets` in your frontend to implement the 
 contribution lifecycle in your React application.
 
-As an example, see [the demo application](../dashi/src/demo).
+As an example, see [the demo application](../chartlets/src/demo).