搜索插件、代码仓与 APP 分类

chaquopy 封面
插件详情v0.0.20

chaquopy

Chaquopy 插件,使用 Chaquopy SDK 在 Flutter 应用中运行 Python 脚本。

Android
近 30 天下载
218
喜欢数
117
Pub 分数
160

安装插件

flutter pub add chaquopy

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Chaquopy 是一个 Flutter 插件,通过 Chaquopy SDK 实现在 Android 应用中运行 Python 脚本。它允许将 Python 代码无缝集成到 Flutter 应用中,使 Dart 可以直接访问 Python 库和框架。这对于在移动应用中利用机器学习模型、数据处理任务或现有的基于 Python 的逻辑非常有用。该插件简化了在 Android 设备上设置和执行 Python 代码的过程,无需单独的后端服务。

适合场景

  • 在Flutter应用中运行机器学习模型
  • 集成Python库进行数据分析
  • 在移动应用中执行旧版 Python 脚本
  • 执行复杂的数学计算
  • 在 Android 应用中使用基于 Python 的 API

主要特点

  • 与 Flutter 的原生 Python 集成
  • 对流行 Python 包的支持
  • 通过 Flutter pub 轻松设置
  • 仅在 Android 上运行
  • 轻量且高效的执行

适合对象

  • 具有 Python 专长的开发人员
  • 需要高级数据处理的应用程序
  • 基于机器学习的移动应用
  • 重用现有 Python 代码库的项目
  • 专注于 Android 的 Flutter 开发人员

使用建议

  • 仅限 Android 平台
  • 由于 Python 运行时导致应用体积增大
  • 重型计算可能带来的性能开销
  • 需要了解 Dart 和 Python
  • 不适用于 iOS 部署

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Chaquopy Flutter plugin

This is an unofficial Chaquopy Flutter plugin to run Python code on Android. This is the simplest version, where you can write your code and run it.

Configuration Steps :

Add maven { url "https://chaquo.com/maven" } and add chaquopy dependency in dependencies section at project level gradle.build like following : You can find the latest-version of chaquopy here, also make sure to update the gradle, python and minimum SDK versions accordingly. You can find the compatible python, android gradle version and minimum SDK version based on chaquopy version here:

buildscript {
    repositories {
        google()
        jcenter()
        maven { url "https://chaquo.com/maven" }
    }
    dependencies {
        ...
        classpath "com.chaquo.python:gradle:latest-version"
    }
}

Then, in the module-level build.gradle file (usually in the app directory), apply the Chaquopy plugin at the top of the file, but after the Android plugin:

apply plugin: 'com.android.application' 
apply plugin: 'com.chaquo.python' 

Apply ABI selection using following code.

defaultConfig {
    ndk {
       abiFilters "armeabi-v7a", "arm64-v8a", "x86", "x86_64"
    }
}

add this line to application tag in manifest file

android:name="com.chaquo.python.android.PyApplication".

After that sync your project.

Now, in your android folder, you'll have additional python folder created. Now, Download script.py and put it in python directory. (Kindly note that this python file should not be renamed other than script.py and also if your code doesn't work, check the intendations of the downloaded file.)

Now in order to use the chaquopy plugin import the chaquopy package in your flutter app through declaring the package inside pubspec.yaml file.

Now you can run the code easily by calling Chaquopy.executeCode(code) function which returns a map.

The map returned contains two properties and it contains follwing structure:

{
    "textOutputOrError" : "code output or error",
}

you can easily access this code via result["textOutputOrError"] , where result is variable of type map and you can name it anything you want.

FAQs:

  1. Why it shows the notification and also crashes the app after some time limit?

    This plugin uses Chaquopy SDK, which uses a license for the unlimited use case. In order to remove the notification and timelimit, you need to contact here for the license and after you get your license, you need to follow add follwing two lines in your local.properties file.

    1. chaquopy.license=your_license_key
    2. chaquopy.applicationId=package name of the app
  2. Can I use python packages?

    You can use all the python packages by using following configuration.

    defaultConfig {
        python {
            pip {
                install "scipy"
                install "numpy"
                //  specify any other package to install.
            }
        }
    }
    
  3. Why this package doesn't support OpenCV, Matplotlib and NLTK packages?

    I am writing reasons for individual packages here.

    1. OpenCV and Matplotlib : OpenCV and Matplotlib Requires a special configuration, I am working on this issue to be able to integrate in the package itself.

    2. NLTK and Spacy : NLTK and Spacy Packages can be installed and technically run on your device, but most of the NLTK and Spacy functionality relies on it's data that you will be downloading using nltk.download('all'). so It increases the size of the app significantly. I am also working on this feature.

  4. App Size Reduction:

    Using ABI Selection settings you can reduce the app size. The Python interpreter is a native component, so you must use the abiFilters setting to specify which ABIs you want the app to support. The currently available ABIs are:

    armeabi-v7a, supported by virtually all Android devices.

    arm64-v8a, supported by most recent Android devices.

    x86, for the Android emulator.

    x86_64, for the Android emulator.

During development you’ll probably want to enable them all, i.e.:

defaultConfig {
    ndk {
       abiFilters "armeabi-v7a", "arm64-v8a", "x86", "x86_64"
    }
}
  1. buildPython:

Some features require Python 3.5 or later to be available on the build machine. These features are indicated by a note in their documentation sections.

By default, Chaquopy will try to find Python on the PATH with the standard command for your operating system, first with a matching minor version, and then with a matching major version. For example, if Chaquopy’s own Python version is 3.8.x, then:

    On Linux and Mac it will try python3.8, then python3.

    On Windows, it will try py -3.8, then py -3.

If this doesn’t work for you, set your Python command using the buildPython setting. For example, on Windows you might use one of the following:

defaultConfig {
    python {
        buildPython "C:/path/to/python.exe"
        buildPython "C:/path/to/py.exe", "-3.8"
    }
}
  1. If you're facing Kotlin and Java compatibility issues, you can provide kotlin/java configuration as following:
android {
    compileSdk 34
    namespace 'com.chaquopy.chaquopy_example'

    kotlin {
        jvmToolchain(17)
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_17
        targetCompatibility JavaVersion.VERSION_17
    }
}
  1. You might need to update dsitributionUrl for the gradle based on the version you're using, which you can do inside gradle-wrapper.properties. you can find the available gradle urls here:
distributionUrl=URL
  1. Future Plans :

    [ ] Add support for opencv and matplotlib

    [ ] Add support for NLTK and Spacy

    [ ] Add support for apple devices as well. If you want to help me out with it, kindly contact me,through mail, and I will be happy make this plugin better.

Demo :

Queries :

All the configurations of chaquopy will work the same way, it's mentioned on the chaquopy sdk home page. if you don't find any solution you can open issue in the repository and I am happy to help. :)

所属分类

源码仓库

使用此插件的项目

暂无相关数据。