kivy / buildozer

Generic Python packager for Android and iOS
https://buildozer.readthedocs.io
MIT License
1.73k stars 499 forks source link

Buildozer fails when there are extra/irrelevant py-files with errors in the 'main'-directory #993

Closed HeRo002 closed 4 years ago

HeRo002 commented 4 years ago

A bug - or inconvenience - in Buildozer:

I have a test app which works, and Buildozer can deploy it on my Android phone. Great! But if the directory (folder) contains another py-file, named "main-nyt-eksperiment.py", which contains errors, because it's only half finished, Buildozer will fail to deploy the app on the Android phone. I used the buildozer.spec file that was included when I installed a few weeks ago. I have included the log information from Terminal and the content of the buildozer.spec-file and "main-nyt-eksperiment.py" (a modified version of the Kivy example Touchtracer.py) below.

Versions

Description

See above.

buildozer.spec

Command: buildozer android debug deploy run (in Terminal on Ubuntu)

Spec file: (Identical to the one I installed a few weeks ago.)

[app]

(str) Title of your application

title = My Application

(str) Package name

package.name = myapp

(str) Package domain (needed for android/ios packaging)

package.domain = org.test

(str) Source code where the main.py live

source.dir = .

(list) Source files to include (let empty to include all the files)

source.include_exts = py,png,jpg,kv,atlas

(list) List of inclusions using pattern matching

source.include_patterns = assets/,images/.png

(list) Source files to exclude (let empty to not exclude anything)

source.exclude_exts = spec

(list) List of directory to exclude (let empty to not exclude anything)

source.exclude_dirs = tests, bin

(list) List of exclusions using pattern matching

source.exclude_patterns = license,images//.jpg

(str) Application versioning (method 1)

version = 0.1

(str) Application versioning (method 2)

version.regex = version = '"['"]

version.filename = %(source.dir)s/main.py

(list) Application requirements

comma separated e.g. requirements = sqlite3,kivy

requirements = python3,kivy

(str) Custom source folders for requirements

Sets custom source for any requirements with recipes

requirements.source.kivy = ../../kivy

(list) Garden requirements

garden_requirements =

(str) Presplash of the application

presplash.filename = %(source.dir)s/data/presplash.png

(str) Icon of the application

icon.filename = %(source.dir)s/data/icon.png

(str) Supported orientation (one of landscape, sensorLandscape, portrait or all)

orientation = portrait

(list) List of service to declare

services = NAME:ENTRYPOINT_TO_PY,NAME2:ENTRYPOINT2_TO_PY

#

OSX Specific

#

#

author = © Copyright Info

change the major version of python used by the app

osx.python_version = 3

Kivy version to use

osx.kivy_version = 1.9.1

#

Android specific

#

(bool) Indicate if the application should be fullscreen or not

fullscreen = 0

(string) Presplash background color (for new android toolchain)

Supported formats are: #RRGGBB #AARRGGBB or one of the following names:

red, blue, green, black, white, gray, cyan, magenta, yellow, lightgray,

darkgray, grey, lightgrey, darkgrey, aqua, fuchsia, lime, maroon, navy,

olive, purple, silver, teal.

android.presplash_color = #FFFFFF

(list) Permissions

android.permissions = INTERNET

(int) Target Android API, should be as high as possible.

android.api = 27

(int) Minimum API your APK will support.

android.minapi = 21

(int) Android SDK version to use

android.sdk = 20

(str) Android NDK version to use

android.ndk = 17c

(int) Android NDK API to use. This is the minimum API your app will support, it should usually match android.minapi.

android.ndk_api = 21

(bool) Use --private data storage (True) or --dir public storage (False)

android.private_storage = True

(str) Android NDK directory (if empty, it will be automatically downloaded.)

android.ndk_path =

(str) Android SDK directory (if empty, it will be automatically downloaded.)

android.sdk_path =

(str) ANT directory (if empty, it will be automatically downloaded.)

android.ant_path =

(bool) If True, then skip trying to update the Android sdk

This can be useful to avoid excess Internet downloads or save time

when an update is due and you just want to test/build your package

android.skip_update = False

(bool) If True, then automatically accept SDK license

agreements. This is intended for automation only. If set to False,

the default, you will be shown the license when first running

buildozer.

android.accept_sdk_license = False

(str) Android entry point, default is ok for Kivy-based app

android.entrypoint = org.renpy.android.PythonActivity

(list) Pattern to whitelist for the whole project

android.whitelist =

(str) Path to a custom whitelist file

android.whitelist_src =

(str) Path to a custom blacklist file

android.blacklist_src =

(list) List of Java .jar files to add to the libs so that pyjnius can access

their classes. Don't add jars that you do not need, since extra jars can slow

down the build process. Allows wildcards matching, for example:

OUYA-ODK/libs/*.jar

android.add_jars = foo.jar,bar.jar,path/to/more/*.jar

(list) List of Java files to add to the android project (can be java or a

directory containing the files)

android.add_src =

(list) Android AAR archives to add (currently works only with sdl2_gradle

bootstrap)

android.add_aars =

(list) Gradle dependencies to add (currently works only with sdl2_gradle

bootstrap)

android.gradle_dependencies =

(list) Java classes to add as activities to the manifest.

android.add_activites = com.example.ExampleActivity

(str) OUYA Console category. Should be one of GAME or APP

If you leave this blank, OUYA support will not be enabled

android.ouya.category = GAME

(str) Filename of OUYA Console icon. It must be a 732x412 png image.

android.ouya.icon.filename = %(source.dir)s/data/ouya_icon.png

(str) XML file to include as an intent filters in tag

android.manifest.intent_filters =

(str) launchMode to set for the main activity

android.manifest.launch_mode = standard

(list) Android additional libraries to copy into libs/armeabi

android.add_libs_armeabi = libs/android/*.so

android.add_libs_armeabi_v7a = libs/android-v7/*.so

android.add_libs_arm64_v8a = libs/android-v8/*.so

android.add_libs_x86 = libs/android-x86/*.so

android.add_libs_mips = libs/android-mips/*.so

(bool) Indicate whether the screen should stay on

Don't forget to add the WAKE_LOCK permission if you set this to True

android.wakelock = False

(list) Android application meta-data to set (key=value format)

android.meta_data =

(list) Android library project to add (will be added in the

project.properties automatically.)

android.library_references =

(list) Android shared libraries which will be added to AndroidManifest.xml using tag

android.uses_library =

(str) Android logcat filters to use

android.logcat_filters = *:S python:D

(bool) Copy library instead of making a libpymodules.so

android.copy_libs = 1

(str) The Android arch to build for, choices: armeabi-v7a, arm64-v8a, x86, x86_64

android.arch = armeabi-v7a

#

Python for android (p4a) specific

#

(str) python-for-android fork to use, defaults to upstream (kivy)

p4a.fork = kivy

(str) python-for-android branch to use, defaults to master

p4a.branch = master

(str) python-for-android git clone directory (if empty, it will be automatically cloned from github)

p4a.source_dir =

(str) The directory in which python-for-android should look for your own build recipes (if any)

p4a.local_recipes =

(str) Filename to the hook for p4a

p4a.hook =

(str) Bootstrap to use for android builds

p4a.bootstrap = sdl2

(int) port number to specify an explicit --port= p4a argument (eg for bootstrap flask)

p4a.port =

#

iOS specific

#

(str) Path to a custom kivy-ios folder

ios.kivy_ios_dir = ../kivy-ios

Alternately, specify the URL and branch of a git checkout:

ios.kivy_ios_url = https://github.com/kivy/kivy-ios ios.kivy_ios_branch = master

Another platform dependency: ios-deploy

Uncomment to use a custom checkout

ios.ios_deploy_dir = ../ios_deploy

Or specify URL and branch

ios.ios_deploy_url = https://github.com/phonegap/ios-deploy ios.ios_deploy_branch = 1.7.0

(str) Name of the certificate to use for signing the debug version

Get a list of available identities: buildozer ios list_identities

ios.codesign.debug = "iPhone Developer: ()"

(str) Name of the certificate to use for signing the release version

ios.codesign.release = %(ios.codesign.debug)s

[buildozer]

(int) Log level (0 = error only, 1 = info, 2 = debug (with command output))

log_level = 2

(int) Display warning if buildozer is run as root (0 = False, 1 = True)

warn_on_root = 1

(str) Path to build artifact storage, absolute or relative to spec file

build_dir = ./.buildozer

(str) Path to build output (i.e. .apk, .ipa) storage

bin_dir = ./bin

-----------------------------------------------------------------------------

List as sections

#

You can define all the "list" as [section:key].

Each line will be considered as a option to the list.

Let's take [app] / source.exclude_patterns.

Instead of doing:

#

[app]

source.exclude_patterns = license,data/audio/.wav,data/images/original/

#

This can be translated into:

#

[app:source.exclude_patterns]

license

data/audio/*.wav

data/images/original/*

#

-----------------------------------------------------------------------------

Profiles

#

You can extend section / key with a profile

For example, you want to deploy a demo version of your application without

HD content. You could first change the title to add "(demo)" in the name

and extend the excluded directories to remove the HD content.

#

[app@demo]

title = My Application (demo)

#

[app:source.exclude_patterns@demo]

images/hd/*

#

Then, invoke the command line with the "demo" profile:

#

buildozer --profile demo android debug

Logs (from Ubuntu Terminal):

henrik@Henrik-L570:/mnt/4AF15A0435E762B4/DataDoc/OneDrive/PycharmProjects/2d-graphics/touchtracer$ buildozer android debug deploy run

Check configuration tokens

Ensure build layout

Check configuration tokens

Preparing build

Check requirements for android

Run 'dpkg --version'

Cwd None

Debian 'dpkg' package management program version 1.19.0.5 (amd64). This is free software; see the GNU General Public License version 2 or later for copying conditions. There is NO warranty.

Search for Git (git)

-> found at /usr/bin/git

Search for Cython (cython)

-> found at /home/henrik/.local/bin/cython

Search for Java compiler (javac)

-> found at /usr/lib/jvm/java-8-openjdk-amd64/bin/javac

Search for Java keytool (keytool)

-> found at /usr/lib/jvm/java-8-openjdk-amd64/jre/bin/keytool

Install platform

Run 'git config --get remote.origin.url'

Cwd /mnt/4AF15A0435E762B4/DataDoc/OneDrive/PycharmProjects/2d-graphics/touchtracer/.buildozer/android/platform/python-for-android

https://github.com/kivy/python-for-android.git

Run 'git branch -vv'

Cwd /mnt/4AF15A0435E762B4/DataDoc/OneDrive/PycharmProjects/2d-graphics/touchtracer/.buildozer/android/platform/python-for-android

The content of the 'irrelevant' Python file "main-nyt-eksperiment.py" containing an error:

''' Touch Tracer Line Drawing Demonstration

This demonstrates tracking each touch registered to a device. You should see a basic background image. When you press and hold the mouse, you should see cross-hairs with the coordinates written next to them. As you drag, it leaves a trail. Additional information, like pressure, will be shown if they are in your device's touch.profile.

.. note::

A function calculate_points handling the points which will be drawn has by default implemented a delay of 5 steps. To get more precise visual results lower the value of the optional keyword argument steps.

This program specifies an icon, the file icon.png, in its App subclass. It also uses the particle.png file as the source for drawing the trails which are white on transparent. The file touchtracer.kv describes the application.

The file android.txt is used to package the application for use with the Kivy Launcher Android application. For Android devices, you can copy/paste this directory into /sdcard/kivy/touchtracer on your Android device.

'''

version = '1.0'

import kivy kivy.require('1.11.1')

from kivy.app import App from kivy.uix.floatlayout import FloatLayout from kivy.uix.boxlayout import BoxLayout from kivy.uix.label import Label from kivy.graphics import Color, Rectangle, Point, GraphicException from random import random from math import sqrt from kivy.lang import Builder

Making 'touchtracer.kv' obsolete (I also had to rename it...):

Builder.load_string('''

:kivy 1.11.1

:import kivy kivy

: BoxLayout: : canvas: Color: rgb: 1, 1, 1 Rectangle: pos: self.pos size: self.size BoxLayout: padding: '10dp' spacing: '10dp' size_hint: 1, None pos_hint: {'top': 1} height: '44dp' Image: size_hint: None, None size: '24dp', '24dp' source: 'data/logo/kivy-icon-64.png' mipmap: True Label: height: '24dp' # size: self.texture_size text_size: self.size # Cryptic alternative: text_size: self.width, None color: (0, 0, 0, 1) text: 'Geo-ESP traning (Text now in py-file) %s ' % app.name valign: 'middle' ''') def calculate_points(x1, y1, x2, y2, steps=5): dx = x2 - x1 dy = y2 - y1 dist = sqrt(dx * dx + dy * dy) if dist < steps: return o = [] m = dist / steps for i in range(1, int(m)): mi = i / m lastx = x1 + dx * mi lasty = y1 + dy * mi o.extend([lastx, lasty]) return o class Touchtracer(FloatLayout): def on_touch_down(self, touch): win = self.get_parent_window() ud = touch.ud ud['group'] = g = str(touch.uid) pointsize = 5 if 'pressure' in touch.profile: ud['pressure'] = touch.pressure pointsize = (touch.pressure * 100000) ** 2 ud['color'] = random() with self.canvas: Color(ud['color'], 1, 1, mode='hsv', group=g) ud['lines'] = [ Rectangle(pos=(touch.x, 0), size=(1, win.height), group=g), Rectangle(pos=(0, touch.y), size=(win.width, 1), group=g), Point(points=(touch.x, touch.y), source='particle.png', pointsize=pointsize, group=g)] # ud['label'] = Label(size_hint=(None, None)) # self.update_touch_label(ud['label'], touch) # self.add_widget(ud['label']) touch.grab(self) return True def on_touch_move(self, touch): if touch.grab_current is not self: return ud = touch.ud ud['lines'][0].pos = touch.x, 0 ud['lines'][1].pos = 0, touch.y index = -1 while True: try: points = ud['lines'][index].points oldx, oldy = points[-2], points[-1] break except: index -= 1 points = calculate_points(oldx, oldy, touch.x, touch.y) # if pressure changed create a new point instruction if 'pressure' in ud: if not .95 < (touch.pressure / ud['pressure']) < 1.05: g = ud['group'] pointsize = (touch.pressure * 100000) ** 2 with self.canvas: Color(ud['color'], 1, 1, mode='hsv', group=g) ud['lines'].append( Point(points=(), source='particle.png', pointsize=pointsize, group=g)) if points: try: lp = ud['lines'][-1].add_point for idx in range(0, len(points), 2): lp(points[idx], points[idx + 1]) except GraphicException: pass # ud['label'].pos = touch.pos # import time # t = int(time.time()) # if t not in ud: # ud[t] = 1 # else: # ud[t] += 1 # self.update_touch_label(ud['label'], touch) def on_touch_up(self, touch): if touch.grab_current is not self: return touch.ungrab(self) # ud = touch.ud # self.canvas.remove_group(ud['group']) # self.remove_widget(ud['label']) def update_touch_label(self, label, touch): label.text = 'ID: %s\nPos: (%d, %d)\nClass: %s' % ( touch.id, touch.x, touch.y, touch.__class__.__name__) label.texture_update() label.pos = touch.pos label.size = label.texture_size[0] + 20, label.texture_size[1] + 20 class Geo_esp_train_window(BoxLayout): class Geo_esp_trainingApp(App): # title = 'Touchtracer - Henrik Test1' (Deprecated??) # icon = 'icon.png' (Deprecated??) def build(self): self.title = 'Geo-ESP traning - Henrik text in py-file' # This becomes the title in the top-bar in a window on Ubuntu, # but is not used on android phone when using "PycharmProjects/2d-graphics/touchtracer$ buildozer android debug deploy run". self.icon = 'icon.png' return Geo_esp_train_window() def on_pause(self): return True if __name__ == '__main__': TouchtracerApp().run()
AndreMiras commented 4 years ago

This is a feature of buildozer, building whatever is in the source.dir. To exclude things, you can use source.exclude_dirs and source.exclude_patterns