Installing self-built wheels on Android

[mhsmith]

Moved from #958:

---

@kfchou commented:

I have 2 wheels I'd like to use:

In briefcase' pyproject.toml file:

[tool.briefcase.app.numpy_test.android]
requires = [
    "toga-android~=0.5.0",
    "file:///home/kfchou/repos/my_numpy/numpy/android_test/numpy_test/wheels/numpy-2.4.0.dev0-cp313-cp313-android_21_arm64_v8a.whl",
    "file:///home/kfchou/repos/my_numpy/numpy/android_test/numpy_test/wheels/numpy-2.4.0.dev0-cp313-cp313-android_21_x86_64.whl",
]

pip_install_args = [
    "--extra-index-url=/home/kfchou/repos/my_numpy/numpy/android_test/numpy_test/wheels/",
    ]

Note that the android_21 tag is incorrect; I had specified android_30. This is an issue on my end.

Nevertheless, the build fails with:

> Task :app:generateDebugPythonRequirements
Chaquopy: Installing for arm64-v8a
Looking in indexes: https://pypi.org/simple, https://chaquo.com/pypi-13.1
Collecting toga-android~=0.5.0
  Using cached toga_android-0.5.2-py3-none-any.whl (69 kB)
Processing /home/kfchou/repos/my_numpy/numpy/android_test/numpy_test/wheels/numpy-2.4.0.dev0-cp313-cp313-android_21_arm64_v8a.whl
Collecting toga-core==0.5.2
  Using cached toga_core-0.5.2-py3-none-any.whl (145 kB)
Collecting travertino==0.5.2
  Using cached travertino-0.5.2-py3-none-any.whl (24 kB)
Installing collected packages: travertino, toga-core, toga-android, numpy
Successfully installed numpy-2.4.0.dev0 toga-android-0.5.2 toga-core-0.5.2 travertino-0.5.2
Chaquopy: Installing for x86_64
Looking in indexes: https://pypi.org/simple, https://chaquo.com/pypi-13.1
ERROR: Could not find a version that satisfies the requirement numpy==2.4.0.dev0 (from versions: 1.3.0, 1.4.1, 1.5.0, 1.5.1, 1.6.0, 1.6.1, 1.6.2, 1.7.0, 1.7.1, 1.7.2, 1.8.0, 1.8.1, 1.8.2, 1.9.0, 1.9.1, 1.9.2, 1.9.3, 1.10.0.post2, 1.10.1, 1.10.2, 1.10.4, 1.11.0, 1.11.1, 1.11.2, 1.11.3, 1.12.0, 1.12.1, 1.13.0, 1.13.1, 1.13.3, 1.14.0, 1.14.1, 1.14.2, 1.14.3, 1.14.4, 1.14.5, 1.14.6, 1.15.0, 1.15.1, 1.15.2, 1.15.3, 1.15.4, 1.16.0, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.16.6, 1.17.0, 1.17.1, 1.17.2, 1.17.3, 1.17.4, 1.17.5, 1.18.0, 1.18.1, 1.18.2, 1.18.3, 1.18.4, 1.18.5, 1.19.0, 1.19.1, 1.19.2, 1.19.3, 1.19.4, 1.19.5, 1.20.0, 1.20.1, 1.20.2, 1.20.3, 1.21.0, 1.21.1, 1.22.0, 1.22.1, 1.22.2, 1.22.3, 1.22.4, 1.23.0, 1.23.1, 1.23.2, 1.23.3, 1.23.4, 1.23.5, 1.24.0, 1.24.1, 1.24.2, 1.24.3, 1.24.4, 1.25.0, 1.25.1, 1.25.2, 1.26.2, 1.26.3, 1.26.4, 2.0.0, 2.0.1, 2.0.2, 2.1.0, 2.1.1, 2.1.2, 2.1.3, 2.2.0, 2.2.1, 2.2.2, 2.2.3, 2.2.4, 2.2.5, 2.2.6, 2.3.0, 2.3.1, 2.3.2)
ERROR: No matching distribution found for numpy==2.4.0.dev0
Chaquopy: Exit status 1

> Task :app:generateDebugPythonRequirements FAILED

How come the build process is not honoring the x86_64.whl file?

I haven't tried to build numpy 2.3.2. Would that be the issue?

It is possible that the wheels are not compiled correctly; I'm trying to test them. The best way I thought to do this was to build a briefcase example project (briefcase start) and ask it to import numpy.

Please advise

---

@mhsmith commented:

You can't mix wheels for multiple architectures in your requires list, because each architecture is installed with a separate run of pip. Instead, your requires list should simply say numpy==2.4.0.dev0.

There is no pip_install_args setting. Where did you get that from? The correct setting is requirement_installer_args.

Finally, for pip's --extra-index-url option to work, you'll need to put the wheels inside a numpy subdirectory. Alternatively, you can use --find-links, which expects a flat directory layout. See the requirement_installer_args documentation for examples.

---

@kfchou commented:

Thanks for your response @mhsmith . I've updated my configurations but the build is still failing. My pyproject.toml file has

[tool.briefcase.app.numpy_test.android]
requires = [
    "toga-android~=0.5.0",
    "numpy==2.4.0.dev0",
]

requirement_install_args = [
    "--find-links", "./wheels/numpy",
    ]

# also tried

requirement_install_args = [
    "--extra-index-url", "./wheels",
    ]

and my directory structure is

.
├── CHANGELOG
├── LICENSE
├── README.rst
├── build
│   └── numpy_test
│       └── android
├── logs
├── pyproject.toml <----- config file
├── src
│   └── numpy_test
│       ├── __init__.py
│       ├── __main__.py
│       ├── app.py
│       └── resources
├── tests
│   ├── __init__.py
│   ├── numpy_test.py
│   └── test_app.py
└── wheels
    └── numpy
        ├── numpy-2.4.0.dev0-cp313-cp313-android_21_arm64_v8a.whl
        └── numpy-2.4.0.dev0-cp313-cp313-android_21_x86_64.whl

The build log suggests pip is still looking in pypi:

> Task :app:generateDebugPythonRequirements
Chaquopy: Installing for arm64-v8a
Looking in indexes: https://pypi.org/simple, https://chaquo.com/pypi-13.1
Collecting toga-android~=0.5.0
  Using cached toga_android-0.5.2-py3-none-any.whl (69 kB)
ERROR: Could not find a version that satisfies the requirement numpy==2.4.0.dev0 (from -r requirements.txt (line 3)) (from versions: 1.3.0, 1.4.1, 1.5.0, 1.5.1, 1.6.0, 1.6.1, 1.6.2, 1.7.0, 1.7.1, 1.7.2, 1.8.0, 1.8.1, 1.8.2, 1.9.0, 1.9.1, 1.9.2, 1.9.3, 1.10.0.post2, 1.10.1, 1.10.2, 1.10.4, 1.11.0, 1.11.1, 1.11.2, 1.11.3, 1.12.0, 1.12.1, 1.13.0, 1.13.1, 1.13.3, 1.14.0, 1.14.1, 1.14.2, 1.14.3, 1.14.4, 1.14.5, 1.14.6, 1.15.0, 1.15.1, 1.15.2, 1.15.3, 1.15.4, 1.16.0, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.16.6, 1.17.0, 1.17.1, 1.17.2, 1.17.3, 1.17.4, 1.17.5, 1.18.0, 1.18.1, 1.18.2, 1.18.3, 1.18.4, 1.18.5, 1.19.0, 1.19.1, 1.19.2, 1.19.3, 1.19.4, 1.19.5, 1.20.0, 1.20.1, 1.20.2, 1.20.3, 1.21.0, 1.21.1, 1.22.0, 1.22.1, 1.22.2, 1.22.3, 1.22.4, 1.23.0, 1.23.1, 1.23.2, 1.23.3, 1.23.4, 1.23.5, 1.24.0, 1.24.1, 1.24.2, 1.24.3, 1.24.4, 1.25.0, 1.25.1, 1.25.2, 1.26.2, 1.26.3, 1.26.4, 2.0.0, 2.0.1, 2.0.2, 2.1.0, 2.1.1, 2.1.2, 2.1.3, 2.2.0, 2.2.1, 2.2.2, 2.2.3, 2.2.4, 2.2.5, 2.2.6, 2.3.0, 2.3.1, 2.3.2)
ERROR: No matching distribution found for numpy==2.4.0.dev0 (from -r requirements.txt (line 3))
Chaquopy: Exit status 1

Is there something I'm missing?

[mhsmith]

The correct setting is requirement_installer_args, not requirement_install_args.

[mhsmith]

Try adding --pre to requirement_installer_args. I didn't think it was necessary when asking for a specific pre-release version, but maybe it's different when installing via a requirements file.

[mhsmith]

Perhaps something is inconsistent with my wheel's metadata?

I don't think so, because it doesn't look as if pip is even detecting the wheel in the intial phase, which only looks at the filenames.

I've reproduced your project as closely as I can, populating the wheels/numpy directory with a couple of random wheels which I've renamed. And for both 2.4.0.dev0 and 1.26.2, it displays the "Processing" message with the correct filename, and only then gives the expected error about the wheel's content not matching its name.

So it looks like my guess about --pre was wrong. Are you sure your wheels/numpy directory has exactly the same filenames as me?

-rw-r--r--@ 1 msmith  staff  10786923 Aug 21 11:26 numpy-1.26.2-0-cp313-cp313-android_24_arm64_v8a.whl
-rw-r--r--@ 1 msmith  staff  11734993 Dec 22  2023 numpy-2.4.0.dev0-cp313-cp313-android_21_arm64_v8a.whl

If you add -v to requirement_installer_args, pip may give more information about how it decides which files to use.

[kfchou]

Thank you, the -v flag was revealing:

Chaquopy: Running ['/home/kfchou/repos/my_numpy/numpy/android_test/numpy_test/build/numpy_test/android/gradle/app/build/python/env/debug/bin/python', '-m', 'pip', 'install', '--isolated', '--target', '/home/kfchou/repos/my_numpy/numpy/android_test/numpy_test/build/numpy_test/android/gradle/app/build/python/pip/debug/arm64-v8a', '--platform', 'android_24_arm64_v8a', '--disable-pip-version-check', '--extra-index-url', 'https://chaquo.com/pypi-13.1', '--implementation', 'cp', '--python-version', '3.13.0', '--abi', 'cp313', '--no-compile', '-v', '--no-index', '--find-links', '/home/kfchou/repos/my_numpy/numpy/android_test/numpy_test/wheels/numpy', '-r', 'requirements.txt']

...
Skipping link: none of the wheel's tags match: cp313-cp313-android_30_x86_64: file:///home/kfchou/repos/my_numpy/numpy/android_test/numpy_test/wheels/numpy/numpy-2.4.0.dev0-cp313-cp313-android_30_x86_64.whl
Skipping link: none of the wheel's tags match: cp313-cp313-android_30_arm64_v8a: file:///home/kfchou/repos/my_numpy/numpy/android_test/numpy_test/wheels/numpy/numpy-2.4.0.dev0-cp313-cp313-android_30_arm64_v8a.whl

The key issue was that pip was called with the flags: '--platform', 'android_24_arm64_v8a'

and somewhere along my build attempts, I had changed the android version tags to

numpy-2.4.0.dev0-cp313-cp313-android_30_arm64_v8a.whl
numpy-2.4.0.dev0-cp313-cp313-android_30_x86_64.whl

and that caused the build to fail.

Changing the filenames back to android_24 or lower resulted in a successful build.

Is there a way to set the Android API level? When building the wheels, I had set the target API level to 30, perhaps I should lower it to 24?

[mhsmith]

24 is the default for both the Chaquopy build-wheel tool and Briefcase, so I recommend you use that everywhere unless there's a specific reason to change it.

You can change your app's minimum API level using min_os_version. As with most pyproject.toml settings, you'll need to rerun briefcase create android to make it take effect.

Pip will accept wheels whose tags are less than or equal to your app's minimum API level.

[kfchou]

That takes care of all my issues. Thank you so much!

For posterity, to use custom wheel files:

1. Place them relative to the configuration pyproject.toml file

   ├── pyproject.toml <----- build configs are here
   └── wheels
     └── numpy
         ├── numpy-2.4.0.dev0-cp313-cp313-android_21_arm64_v8a.whl
         └── numpy-2.4.0.dev0-cp313-cp313-android_21_x86_64.whl
   

2. add requirement_installer_args to pyproject.toml to tell pip where those wheels are:

   [tool.briefcase.app.app_name.android]
   requires = [
       "numpy==2.4.0.dev0",
   ]
   requirement_installer_args = [
       "--find-links", "./wheels/numpy"
       ]

3. If wheels are tagged with android API level >24, add min_os_version to the config

   [tool.briefcase.app.app_name.android]
   min_os_version = "30"