Rename package to @celldl/editor-python-tools and update README to note requirement for @celldl/editor-rdf

Author: dbrnz

.github/workflows/publish.yaml

@@ -1,4 +1,4 @@
-name: Publish the CellDL Editor Tools as a npm package
+name: Publish the CellDL Editor Python Tools as a npm package
 on:
   workflow_dispatch:
 
@@ -35,11 +35,11 @@ jobs:
       - name: Install bun
         run: npm install -g bun
 
-      - name: Build the CellDL Editor Tools
+      - name: Build the CellDL Editor Python Tools
         run: |
           bun install
           bun run build
 
-      - name: Publish the CellDL Editor on npm
+      - name: Publish the CellDL Editor Python Tools on npm
         run: |
           npm publish --access public --no-git-checks

README.md

@@ -1,26 +1,26 @@
-# CellML generation for the CellDL Editor
+# Python tooling for the CellDL Editor
 
-This package provides a Javascript function to convert [BG-RDF](https://bg-rdf.org/) bond-graph models, created by the CellDL Editor, into [CellML](https://cellml.org). It does so by bundling the [bg2cellml](https://github.com/CellDL/BG-Tools) Python package with [Pyodide](https://pyodide.org), allowing it to be used in a Javascript envirinment.
+This package allows [CellML](https://cellml.org) to be generated for [BG-RDF](https://bg-rdf.org/) bond-graph models created by the CellDL Editor. It does so by bundling the [bg2cellml](https://github.com/CellDL/BG-Tools) Python package with the [Pyodide](https://pyodide.org) distribution, allowing `bg2cellml` to be used in a Javascript envirinment.
 
-It is intended to be used in conjunction with the [@celldl/editor](https://www.npmjs.com/package/@celldl/editor) Vue 3 component.
+It is intended to be used with the [@celldl/editor](https://www.npmjs.com/package/@celldl/editor) Vue 3 component and the [@celldl/editor-rdf](https://www.npmjs.com/package/@celldl/editor-rdf) BG-RDF framework.
 
 
 ## Installation
 
 ```
-bun add @celldl/editor-tools
+bun add @celldl/editor-python-tools
 ```
 
 ## Usage
 
 - **vite.config.ts:**
 
-The use of these tools in a Vite production environment requires a plugin to allow Pyodide to be loaded:
+The use of these tools in a Vite production environment requires a plugin for Pyodide:
 
 ```typescript
 import * as vite from 'vite'
 
-import { pyodidePlugin } from '@celldl/editor-tools/vite'
+import { pyodidePlugin } from '@celldl/editor-python-tools/vite'
 
 export default vite.defineConfig({
     plugins: [
@@ -31,33 +31,45 @@ export default vite.defineConfig({
 
 - **Application.vue**
 
+Besides a loaded Pyodide environment, the package requres an initialised BG-RDF framework.
+
 ```vue
 <script setup lang="ts">
 import * as vue from 'vue'
 
-// Editor interface
+// BG-RDF environment
+
+import * as $rdf from '@celldl/editor-rdf'
+
+// Python tools
+
+import { initialisePython, type PyodideAPI } from '@celldl/editor-python-tools'
+import { loadInBrowser } from '@celldl/editor-python-tools/web'
 
-import CellDLEditor from '@celldl/editor'
-import { rdfInterface } from '@celldl/editor'
+// Initialisation before importing the CellDLEditor Vue component
 
-// Initialisation
+const CellDLEditor = vue.defineAsyncComponent(async () => {
 
-import { initialisePython } from '@celldl/editor-tools'
-import { loadInBrowser } from '@celldl/editor-tools/web'
-import type { PyodideAPI } from '@celldl/editor-tools'
+    await $rdf.initialise()
+
+    const rdfInterface: $rdf.RdfInterface = {
+        getRdfStatements: $rdf.bgRdfStatements,
+        oximockRdfModule: $rdf.oxiRdfModule
+    }
 
-vue.nextTick().then(async () => {
     await loadInBrowser().then(async (pyodideApi: PyodideAPI) => {
         await initialisePython(pyodideApi, rdfInterface, (msg: string) => {
             console.log(msg)
         })
     })
+
+    return import('@celldl/editor')
 })
 
+
 // CellML generation
 
-import { celldl2cellml } from '@celldl/editor-tools'
-export type { CellMLOutput } from '@celldl/editor-tools'
+import { celldl2cellml, type CellMLOutput } from '@celldl/editor-python-tools'
 
 const celldl: string = '<svg><!-- Valid CellDL --></svg>'
 const celldlUri: string = `https://celldl.org/cellml/${name}`   // Some URI to identify the source

bun.lock

@@ -1,12 +1,12 @@
 {
-  "name": "@celldl/editor-tools",
-  "version": "0.20260217.1",
+  "name": "@celldl/editor-python-tools",
+  "version": "0.20260224.0",
   "author": {
     "name": "David Brooks",
     "email": "d.brooks@auckland.ac.nz"
   },
   "bugs": {
-    "url": "https://github.com/CellDL/CellDLEditorTools/issues"
+    "url": "https://github.com/CellDL/CellDLEditorPythonTools/issues"
   },
   "description": "Python tools for the CellDL Editor",
   "files": [
@@ -23,10 +23,10 @@
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.js",
-  "productName": "CellDLEditorTools",
+  "productName": "CellDLEditorPythonTools",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/CellDL/CellDLEditorTools.git"
+    "url": "git+https://github.com/CellDL/CellDLEditorPythonTools.git"
   },
   "type": "module",
   "scripts": {

package.json

@@ -76,14 +76,14 @@ export interface PyodidePluginOptions {
 }
 
 /**
- * Vite plugin for `@celldl/editor-tools   `, emit missing assets
+ * Vite plugin for `@celldl/editor-python-tools`, emit missing assets
  */
 export function pyodidePlugin(options: PyodidePluginOptions = {}): Plugin[] {
   const {
     customURL = (key:AssetsKey, _, finalMap: FinalAssetsMap) => path.basename(finalMap.get(key)![0]),
     transformAsmJs,
   } = options
-  const distRoot = path.dirname(createRequire(import.meta.url).resolve('@celldl/editor-tools'))
+  const distRoot = path.dirname(createRequire(import.meta.url).resolve('@celldl/editor-python-tools'))
   const assetsNameMap = new Map<AssetsKey, string>()
   const finalAssetsPathMap = new Map<AssetsKey, [path: string, source: string | Uint8Array]>()
   const importers: [path: string, code: string][] = []