Merge pull request #2 from marcomq/rustpython

Using Rustpython instead of Pyo3 for easier android / ios deployment

Author: marcomq

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tauri-plugin-python"
-version = "0.2.1"
+version = "0.3.0"
 authors = [ "Marco Mengelkoch" ]
 description = "A tauri 2 plugin to use python code in the backend."
 keywords = ["rust", "python", "tauri", "gui"]
@@ -16,8 +16,20 @@ repository = "https://github.com/marcomq/tauri-plugin-python"
 tauri = { version = "2" }
 serde = { version = "1", features = ["derive"] }
 thiserror = "2"
-pyo3 = { version = "0.23.3", features=["auto-initialize", "abi3-py39", "generate-import-lib"] }
 lazy_static = "1.5.0"
+pyo3 = { version = "0.23.3", features=["auto-initialize", "abi3-py39", "generate-import-lib"], optional = true }
+rustpython-pylib = { version = "0.4.0" }
+rustpython-stdlib = { version = "0.4.0", features = ["threading"] }
+rustpython-vm = { version = "0.4.0", features = [
+    "importlib",
+    "serde",
+    "threading",
+] }
+serde_json = "1.0.136"
 
 [build-dependencies]
 tauri-plugin = { version = "2", features = ["build"] }
+
+[features]
+# default = ["pyo3"] # enable to use pyo3 instead of rustpython
+pyo3 = ["dep:pyo3"]

README.md

@@ -1,42 +1,66 @@
 # Tauri Plugin Python
 
 This [tauri](https://v2.tauri.app/) plugin is supposed to make it easy to use Python as backend code.
-It uses [PyO3](https://pyo3.rs) to call python from rust.
+It uses [RustPython](https://github.com/RustPython/RustPython) as interpreter to call python from rust.
+RustPython doesn't require python to be installed on the target platform and makes it 
+therefore easy to deploy your production binary. Unfortunately, it has some 
+compatibility issues and is slower than PyO3/CPython. [PyO3](https://pyo3.rs) is also supported as optional Cargo feature for desktop applications. 
+PyO3 uses CPython as interpreter and therefore has a much better compatibility for python libraries.
+It isn't used as default as it requires to make libpython available for the target platform,
+which can be complicated, especially for mobile targets.
+
 The plugin reads by default the file `src-tauri/src-python/main.py` during 
-startup and runs it immediately. Python functions are then registered during initialization 
+startup and runs it immediately. Make sure to add all your python source as tauri resource,
+so it is shipped together with your productioon binaries. Python functions are all registered during plugin initialization 
 and can get called during application workflow.
 
 
 | Platform | Supported |
 | -------- | --------- |
 | Linux    | ✓         |
 | Windows  | ✓         |
-| macOS    | ✓         |
-| Android  | not yet   |
-| iOS      | not yet   |
+| MacOS    | ✓         |
+| Android  | not yet    |
+| iOS      | ✓*        |
+
+`*` Linux, Windows and MacOS support PyO3 and RustPython as interpreter. Android and IOS
+currently only supports RustPython. 
+Android and iOS might also be able to run PyO3 in theory but require to have CPython
+to be compiled for the target platform. I still need to figure out how to 
+cross compile python and PyO3 for iOS and Android. Ping me if you know how to do that.
 
 You can use this plugin for fast prototypes or for production code. 
 It might be possible that you want to use some python library or code that
 is not available for rust yet.
 In case that you want to ship production software packages, you just need 
-to make sure to also ship the python code and python interpreter.
-
-Android and iOS are possible in theory but I still need to figure out how to 
-cross compile python and PyO3 for iOS and android.
-
-Also, this plugin hasn't been optimized yet for production binaries. 
-The target platform therefore either needs to have libpython installed 
-or you manually need to ship the shared libs together with the installer package.
+to make sure to also ship the python code. If you use PyO3, you also need to ship libpython too.
 
 ## Example app
 
 There is a sample Desktop application for Windows/Linux/MacOS using this plugin and vanilla 
-Javascript in [examples/plain-javascript](https://github.com/marcomq/tauri-plugin-python/tree/main/examples/plain-javascript)
+Javascript in [examples/plain-javascript](https://github.com/marcomq/tauri-plugin-python/tree/main/examples/plain-javascript).
+
+
+## Add the plugin to an existing tauri application
 
-## Manual plugin installation / usage
 
 These steps assume that you already have a basic tauri application available. Alternatively, you can immediately start with the example application.
 
+- run `npm run tauri add python`
+- add `src-tauri/src-python/main.py` and modify it acording to your needs, for example add `def greet_python(intput): return str(input) + " from python"`
+- modify `src-tauri/src/lib.rs` and change `.plugin(tauri_plugin_python::init())` to `.plugin(tauri_plugin_python::init(["greet_python"]))`; make sure you list all python functions you 
+want to call
+- add `"bundle": {"resources": [  "src-python/**/*"],` to `tauri.conf.json` so that python files are bundled with your application
+- add the plugin in your js, so 
+   - add `import { callFunction } from 'tauri-plugin-python-api'` 
+   - add `outputEl.textContent = await callFunction("greet_python", [value])` to get the output of the python function `greet_python` with parameter of js variable `value`
+
+Check the examples for alternative function calls and code sugar.
+
+Tauri events and calling js from python is currently not supported yet. You would need to use rust for that.
+
+## Alternative manual plugin installation
+
 - `$ cargo add tauri-plugin-python`
 - `$ npm install tauri-plugin-python-api`
 - modify `permissions:[]` in src-tauri/capabilities/default.json and add "python:default"  
@@ -76,9 +100,9 @@ The included resources can be configurable in the `tauri.conf.json` file.
 Check the tauri and PyO3 documentation for additional info. 
 
 ## Security considerations
-Generally, this plugin has been created by "security by default" concept. Python functions can only be called if registered from rust.
+Generally, this plugin has been created by "security by default" concept. Python functions can only be called if registered from rust during plugin initialization.
 
-Keep in mind that this plugin can make it possible to run arbitrary python code. 
+Keep in mind that this plugin could make it possible to run arbitrary python code. 
 It is therefore highly recommended to **make sure the user interface is not accessible by a network URL** in production. 
 
 The "runPython" command is disabled by default via permissions. If enabled, it is possible to 

examples/plain-javascript/README.md

@@ -10,14 +10,18 @@ and Vanilla Javascript
 - run `npm install` in the example path (`cd examples/plain-javascript`)
 - run `npm run tauri dev` to start the application
 
+To run this sample app on iOS:
+- run `npx @tauri-apps/cli plugin ios init` to init ios project files
+- run `npm run tauri ios dev` to start the application on iOS in develop mode
+
 ## Manual modifications on default template to add plugin:
 - add `tauri-plugin-python` to Cargo.toml 
 - add `tauri-plugin-python-api` to package.json
 - modify `permissions:[]` in src-tauri/capabilities/default.json and add "python:default"  
 - modify `src-tauri/src-python/main.py` and add python code, for example `def greet_python(..`
-- add `.plugin(tauri_plugin_python::init())` to `src-tauri/src/lib.rs`
+- add `.plugin(tauri_plugin_python::init(["greet_python"]))` to `src-tauri/src/lib.rs`
 - include javascript for python plugin in the index.html file for example by adding `<script type="module" src="/tauri-plugin-python-api/index.iife.js" defer></script>`
-- register python functions in javascript by calling `registerFunction("greet_python");`
+- register python functions in javascript by calling `registerJs("greet_python");`
 - calling python function by calling `call.greet_python(...)`
 
 ## Recommended IDE Setup

examples/plain-javascript/src-tauri/tauri.conf.json

@@ -22,6 +22,9 @@
   "bundle": {
     "active": true,
     "targets": "all",
+    "resources": [
+      "src-python/**/*"
+    ],
     "icon": [
       "icons/32x32.png",
       "icons/128x128.png",

ios/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+DerivedData/
+.swiftpm/config/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc
+Package.resolved

ios/Package.swift

@@ -0,0 +1,32 @@
+// swift-tools-version:5.3
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "tauri-plugin-python",
+    platforms: [
+        .macOS(.v10_13),
+        .iOS(.v13),
+    ],
+    products: [
+        // Products define the executables and libraries a package produces, and make them visible to other packages.
+        .library(
+            name: "tauri-plugin-python",
+            type: .static,
+            targets: ["tauri-plugin-python"]),
+    ],
+    dependencies: [
+        .package(name: "Tauri", path: "../.tauri/tauri-api")
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages this package depends on.
+        .target(
+            name: "tauri-plugin-python",
+            dependencies: [
+                .byName(name: "Tauri")
+            ],
+            path: "Sources")
+    ]
+)

ios/README.md

@@ -0,0 +1,3 @@
+# Tauri Plugin python
+
+A description of this package.

ios/Sources/ExamplePlugin.swift

@@ -0,0 +1,16 @@
+import SwiftRs
+import Tauri
+import UIKit
+import WebKit
+
+class PingArgs: Decodable {
+  let value: String?
+}
+
+class ExamplePlugin: Plugin {
+}
+
+@_cdecl("init_plugin_python")
+func initPlugin() -> Plugin {
+  return ExamplePlugin()
+}

ios/Tests/PluginTests/PluginTests.swift

@@ -0,0 +1,8 @@
+import XCTest
+@testable import ExamplePlugin
+
+final class ExamplePluginTests: XCTestCase {
+    func testExample() throws {
+        let plugin = ExamplePlugin()
+    }
+}

package.json

@@ -1,8 +1,8 @@
 {
   "name": "tauri-plugin-python-api",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "author": "Marco Mengelkoch",
-  "description": "",
+  "description": "Javascript package for tauri 2 python plugin.",
   "type": "module",
   "types": "./dist-js/index.d.ts",
   "main": "./dist-js/index.cjs",
@@ -22,6 +22,15 @@
     "prepublishOnly": "pnpm build",
     "pretest": "pnpm build"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/marcomq/tauri-plugin-python.git"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/marcomq/tauri-plugin-python#readme",
+  "bugs": {
+    "url": "https://github.com/marcomq/tauri-plugin-python/issues"
+  },
   "dependencies": {
     "@tauri-apps/api": ">=2.0.0-beta.6"
   },