Use pyinstaller

.github/workflows/general.yaml

@@ -24,7 +24,7 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.11'
       - name: Install Node
         uses: actions/setup-node@v3
         with:
@@ -50,7 +50,7 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.11'
       - name: Install Node
         uses: actions/setup-node@v3
         with:
@@ -90,7 +90,7 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.11'
       - name: Install Node
         uses: actions/setup-node@v3
         with:

build.py

@@ -1,63 +1,31 @@
 import os
 import shutil
-import sys
-import tarfile
-
-import fsspec
+import PyInstaller.__main__
 
 
 def build_assets():
     source = "desktop/assets"
     target = "build"
 
+    print(f"[assets] Copying '{source}' to '{target}'")
+
     os.makedirs(target, exist_ok=True)
     for name in os.listdir(source):
         shutil.copy(f"{source}/{name}", target)
 
-    print(f"[assets] Copied '{source}' to '{target}'")
-
-
-def build_runner():
-    cache = ".cache"
-    target = "build/runner"
-
-    os.makedirs(cache, exist_ok=True)
-    shutil.rmtree(target, ignore_errors=True)
-
-    datemark = "20230826"
-    basepath = "https://github.com/indygreg/python-build-standalone/releases/download"
-    filetype = "x86_64-unknown-linux-gnu-install_only"
-    if sys.platform == "darwin":
-        filetype = "x86_64-apple-darwin-install_only"
-    if sys.platform == "win32":
-        filetype = "x86_64-pc-windows-msvc-shared-install_only"
-    filename = f"cpython-3.10.13+{datemark}-{filetype}.tar.gz"
-
-    if not os.path.exists(f"{cache}/{filename}"):
-        local = fsspec.filesystem("file")
-        remote = fsspec.filesystem("http")
-        with local.open(f"{cache}/{filename}", "wb") as file_to:
-            with remote.open(f"{basepath}/{datemark}/{filename}", "rb") as file_from:
-                file_to.write(file_from.read())
-
-    with tarfile.open(f"{cache}/{filename}", "r:gz") as tar:
-        tar.extractall(cache)
-        shutil.move(f"{cache}/python", target)
-
-    print(f"[runner] Copied 'runner' to '{target}'")
-
 
 def build_server():
-    source = "server"
-    target = "build/server"
-
-    shutil.rmtree(target, ignore_errors=True)
-    shutil.copytree(source, target)
+    """Build an executable file for the FastAPI server."""
 
-    print(f"[server] Copied '{source}' to '{target}'")
+    print("[server] Creating executable file for FastAPI server")
+    PyInstaller.__main__.run([
+        'server/__main__.py',
+        '--collect-all', 'frictionless',  # Frictionless depends on data files
+        '--distpath', 'build/server',  # Output the file to the build folder
+        '--log-level', 'WARN'
+    ])
 
 
 if __name__ == "__main__":
     build_assets()
-    build_runner()
     build_server()

client/loading.html

@@ -6,22 +6,6 @@
     <meta http-equiv="Content-Security-Policy" content="script-src 'self' 'unsafe-inline';" />
       <script>
       window?.opendataeditor.ensureLogs((message) => {
-        if (message == "python") {
-          var element = document.getElementById("python")
-          var loader = document.getElementById("loader")
-          element.classList.toggle('pending')
-          element.removeChild(loader)
-          var next = document.getElementById("requirements")
-          next.appendChild(loader)
-        }
-        if (message == "requirements") {
-          var element = document.getElementById("requirements")
-          var loader = document.getElementById("loader")
-          element.classList.toggle('pending')
-          element.removeChild(loader)
-          var next = document.getElementById("server")
-          next.appendChild(loader)
-        }
         if (message == "server") {
           var element = document.getElementById("server")
           var loader = document.getElementById("loader")
@@ -61,9 +45,7 @@
         <h1 style="text-align: center;">Open Data Editor is loading</h1>
         <p style="text-align: center;">The first time launching Open Data Editor needs to ensure requirements are installed.</p>
         <ul id="logs">
-          <li class="pending" id="python">Ensure python is installed <span id="loader" class="loader"></span></li>
-          <li class="pending" id="requirements">Ensure python dependencies are installed</li>
-          <li class="pending" id="server">Ensure server is running</li>
+          <li class="pending" id="server">Starting backend Python server<span id="loader" class="loader"></span></li>
         </ul>
       </div>
     </section>

desktop/server.ts

@@ -1,16 +1,22 @@
-import { spawnFile } from './system'
+import cp from 'child_process'
 import * as settings from './settings'
 import log from 'electron-log'
 
 export async function runServer() {
-  log.info(`[Run FastAPI server on port 4040`)
+  log.info(`[FastAPI Server] Running backend server on port 4040`)
 
   // Start production server
-  const proc = spawnFile(
-    settings.PYTHON_TARGET,
-    ['-m', 'server', settings.APP_TMP, '--port', `4040`],
-    process.resourcesPath
-  )
+  const proc = cp.spawn(settings.SERVER_EXEC, [settings.APP_TMP])
 
+  proc.stdout.on('data', (data) => log.info(`[FastAPI Server stdout] ${data.toString().trim()}`))
+  proc.stderr.on('data', (data) => log.error(`[FastAPI Server stderr] ${data.toString().trim()}`))
+  proc.on('close', (code) => {
+    log.info('[FastAPI Server]', { message: `child process exited with code ${code}` })
+  })
+  process.on('exit', () => {
+    log.info('[FastAPI Server]', { message: `exiting child process on node exit` })
+    proc.kill()
+  })
   return proc
 }
+

desktop/settings.ts

@@ -3,18 +3,19 @@ import { join } from 'path'
 
 export const WIN = process.platform === 'win32'
 export const HOME = os.homedir()
+export const APP_NAME = 'opendataeditor'
+export const APP_USER_MODEL_ID = 'org.opendataeditor'
 
+// DIST point to the folder where the application will be installed in the OS
+// opt in Linux and AppData in Windows
 export const DIST = process.resourcesPath
-export const DIST_PYTHON = join(DIST, 'runner')
-export const DIST_SERVER = join(DIST, 'server')
 
-export const APP_NAME = 'opendataeditor'
-export const APP_USER_MODEL_ID = 'org.opendataeditor'
+// Folder in the OS where we will store data generated by the application
+// Example: /home/<user>/.opendataeditor
 export const APP_HOME = join(HOME, `.${APP_NAME}`)
-export const APP_PYTHON = join(APP_HOME, 'runner')
-export const APP_PYTHON_VENV = join(APP_HOME, 'python')
+
 // APP_TMP will be the folder to upload files the first time the user opens the Application
 export const APP_TMP = join(APP_HOME, 'tmp')
 
-export const PYTHON_SOURCE = join(APP_PYTHON, WIN ? 'python.exe' : 'bin/python3')
-export const PYTHON_TARGET = join(APP_PYTHON_VENV, WIN ? 'Scripts\\python.exe' : 'bin/python3')
+// Path to the FastAPI executable file to be run by the Desktop Application
+export const SERVER_EXEC = join(DIST, 'server/__main__', WIN ? '__main__.exe': '__main__')

desktop/window.ts

@@ -4,8 +4,6 @@ import { resolve, join } from 'path'
 import { is } from '@electron-toolkit/utils'
 import log from 'electron-log'
 import * as server from './server'
-import * as python from './python'
-import * as resources from './resources'
 import EventEmitter from 'events'
 
 const loadingEvents = new EventEmitter()
@@ -14,7 +12,7 @@ const loadingEvents = new EventEmitter()
 import icon from './assets/icon.png?asset'
 
 export async function createWindow() {
-  // Create the browser window.
+
   var splashWindow = new BrowserWindow({
     width: 500,
     height: 500,
@@ -58,19 +56,13 @@ export async function createWindow() {
 
   // Open the DevTools.
   // mainWindow.webContents.openDevTools()
-  
+
   if (!is.dev) {
     log.info('Opening loading.html')
     splashWindow.loadFile(resolve(__dirname, '..', 'client', 'loading.html'))
     splashWindow.center()
     log.info('## Start server')
-    await resources.ensurePython()
-    await python.ensurePythonVirtualEnvironment()
-    splashWindow?.webContents.send('ensureLogs', "python")
-    await python.ensurePythonRequirements()
-    splashWindow?.webContents.send('ensureLogs', "requirements")
     await server.runServer()
-    splashWindow?.webContents.send('ensureLogs', "server")
   }
 
   loadingEvents.emit('finished')

electron-builder.yaml

@@ -12,15 +12,8 @@ files:
   - 'build/client/**/*'
   - 'build/desktop/**/*'
 extraResources:
-  - from: 'pyproject.toml'
-    to: 'pyproject.toml'
-  - from: 'build/runner'
-    to: 'runner'
   - from: 'build/server'
     to: 'server'
-    filter:
-      - '**/*'
-      - '!**/__pycache__'
 
 # Linux
 

pyproject.toml

@@ -35,6 +35,8 @@ dependencies = [
     "pygithub==1.59.1",
     # Zenodo
     "pyzenodo3==1.0.2",
+    # PyInstaller
+    "pyinstaller==6.8.0"
 ]
 
 [tool.setuptools]
@@ -45,7 +47,7 @@ path = "package.json"
 pattern = '"version": "(?P<version>.*)"'
 
 [tool.hatch.envs.default]
-python = "3.10"
+python = "3.11"
 dependencies = [
     "ruff",
     "httpx",