Kivy アプリの Windows 用実行ファイルを作成するまで (作製編)

1. PyInstaller を使用する場合

main.py # -*- coding: utf-8 -*- ''' kv ファイルを使用する Sample App ''' from kivy.app import App class MainApp(App): pass if __name__ == "__main__": MainApp().run()

main.kv Root: <Root@BoxLayout>: canvas: Color: rgb: .2, .2, .2 Rectangle: pos: self.pos size: self.size Label: id: lbl text: 'Hello World' Button: text: 'Button' on_release: lbl.text = 'Hello World {}'.format(spn.text) AnchorLayout: anchor_y: 'top' Spinner: size_hint: None, None size: 100, 40 id: spn values: [str(i) for i in range(1, 10)] text: '1'

上記の main.py, main.kv を例に説明します. 適当なディレクトリにこれらのファイルを作製します.

コマンドプロンプトを管理者として開き, main.py ファイルのあるディレクトリに移動し,

python -m PyInstaller --noconsole main.py

を入力します.

main.py のあるディレクトリに生成された main.spec を開き,

# -*- mode: python ; coding: utf-8 -*-

の次の行に,

from kivy_deps import sdl2, glew

を追加し, ('.' ではなく, '_' なので注意*1)

a.datas,

の次の行に,

*[Tree(p) for p in (sdl2.dep_bins + glew.dep_bins)],

を追加します. インデントは揃えます.

datas=[],

を

datas=[('main.kv', '.')],

にします. kv ファイルを使わない場合は, 必要ないはずです.

python -m PyInstaller main.spec

と入力し,

WARNING: The output directory "(main.py のあるディレクトリ)\dist\main" and ALL ITS CONTENTS wil l be REMOVED! Continue? (y/N)

と出たら y を入力します.

dist/main

に main.exe が作製されているので, 実行して画面が表示されたら成功です.

2. Nuitka を使用する場合

main.py # -*- coding: utf-8 -*- ''' nuitka で, --windows-disable-console オプションを使う場合, コンソールへの出力を, 他の object で受け取る必要がある. コンソールの代わりに, 終了時にその内容を log.txt に保存する. ''' import atexit import sys class LogStream: def __init__(self): self.text = '' atexit.register(self.end) def write(self, data): self.text += data def read(self, data): pass def flush(self): pass def close(self): pass def end(self): with open("log.txt", mode='w') as f: f.write(self.text) s = LogStream() sys.stderr = s sys.stdout = s sys.stdin = s ''' nuitka で kivy の exe を作成する場合, 以下を import する必要がある. 必要ないものも入っているかもしれない. ''' import kivy.weakmethod import kivy.graphics.buffer import kivy.graphics.vertex import kivy.graphics.vbo import kivy.graphics.compiler import kivy.graphics.shader import kivy.graphics.svg import kivy.graphics.tesselator import kivy.graphics.cgl_backend.cgl_debug import kivy.graphics.cgl_backend.cgl_gl import kivy.graphics.cgl_backend.cgl_glew import kivy.graphics.cgl_backend.cgl_mock import kivy.graphics.cgl_backend.cgl_sdl2 import kivy.core.image.img_tex import kivy.core.image.img_dds import kivy.core.image.img_sdl2 import kivy.core.image.img_gif import kivy.core.text.text_sdl2 import kivy.core.window.window_sdl2 import kivy.core.window.window_info import kivy.core.audio.audio_sdl2 import kivy.core.clipboard.clipboard_sdl2 ''' nuitka 使用時に, kv ファイルを使用している場合, その kv ファイルで使用した module を import する 必要がある場合がある. Spinner など. Label, Button といった Widget, Color, Rectangle といった 描画命令は必要ないようだ. ただ, 念の為, 使用した全てのクラスを import してもいいかもしれない. ''' import kivy.uix.spinner ''' kv ファイルを使用する Sample App ''' from kivy.app import App class MainApp(App): pass if __name__ == "__main__": MainApp().run()

上記の main.py (main.kv は PyInstaller の項と同じもの) を例に説明します. 適当なディレクトリにこれらのファイルを作製します.

コマンドプロンプトを管理者として開き, main.py ファイルのあるディレクトリに移動し,

python -m nuitka --standalone --windows-disable-console --mingw64 --jobs=1 main.py

と入力します. jobs は, CPU コア数 * 2 にするといいのかもしれません. この作業は時間がかかります. 終了後, main.dist/ に main.exe が作製されます.

Python37-32\Lib\site-packages\kivy\

から data フォルダを main.dist/kivy にコピーし,

Python37-32\share\glew\bin\

から glew32.dll を,

Python37-32\share\sdl2\bin\

から全てのファイルを main.dist にコピーします. *2 最後に, main.kv を main.dist にコピーします.

main.exe を実行して画面が表示されたら成功です.

3. サンプル

以前, Python で迷路生成 で書いた kivy のコードを PyInstaller, Nuitka の両方で exe 化してみました.

PyInstaller

Nuitka

自分の環境では動作する, しないといった報告をしていただけると喜びます. 少なくとも, Linux Mint 18.3 の Wine では動きませんでした.

*1

Create a package for Windows（翻訳済み） − Kivy 1.10.0 ドキュメント:

では kivy.deps になっている. 以前はそうだったのかもしれない.

*2

作製環境でこのサンプルを動かした場合,

• libmpg123-0.dll
• libcrypto-1_1.dll
• libssl-1_1.dll
• libvorbis-0.dll
• libvorbisfile-3.dll
• libwebp-7.dll
• libtiff-5.dll
• libopus-0.dll
• libopusfile-0.dll
• libmodplug-1.dll
• libFLAC-8.dll
• libogg-0.dll
• tcl86t.dll
• tk86t.dll
• sqlite3.dll

は無くても動きました.

参考ページ

Create a package for Windows（翻訳済み） − Kivy 1.10.0 ドキュメント:
KivyのGUIアプリをNuitkaで簡単に小サイズ・高速に動く実行ファイル(exe)にする(Windows10)
Packaging Kivy apps written in Python 3, targeting Windows using Nuitka

19/12/17 追記: 無くても動く dll を列挙した.

Kivy アプリの Windows 用実行ファイルを作成するまで (準備編)

windows 8.1 Home 64bit で, Python がインストールされていない windows でも 実行できる Kivy アプリの exe を作製するまでの過程です.

長くなったので, Python, gcc 等をインストールする準備編, PyInstaller or Nuitka を使用する作製編に分割しました. 後日, ライセンス編も書く予定です.

私の場合, 作成したファイルをネットで公開するつもりなので, Python や gcc 等は 32bit を選択しています. ファイルのバージョンは, メモを書いていた時点での最新を選んでいます.

1. mingw-w64 32bit インストール

http://mingw-w64.org/doku.php/download/mingw-builds

で, Installation: Sourceforge をクリックするとページ遷移し, インストーラが自動的にダウンロードされます.

mingw-w64-install.exe

を実行し,

Ver 8.10
i686
posix
sjlj
0

を選択します.

デフォルトのインストールパスが長いので,

C:\mingw-w64\i686-8.1.0-posix-sjlj-rt_v6-rev0

に変更します.

環境変数の Path に

C:\mingw-w64\i686-8.1.0-posix-sjlj-rt_v6-rev0\mingw32\bin\

を追加します.

コマンドプロンプトを開き,

gcc -v

と入力し, いろいろと情報が出てきたら成功です.

2. Python3 32bit をインストール

https://www.python.org/downloads/windows/

から, Stable Releases の, Nuitka が対応している最新バージョン (現時点では 3.7.5) の Download Windows x86 executable installer をクリックしてインストーラをダウンロードします.

python-3.7.5.exe

を実行します.

Add Python 3.7 to PATH にチェックを入れ, Install Now をクリックします. Path は自動的に追加されるようです.

3. Kivy をインストール

コマンドプロンプトを管理者として開き, 以下の, '#' でコメントアウトしていない行を順に入力します.

python -m pip install --upgrade pip wheel setuptools
python -m pip install docutils pygments pypiwin32 kivy.deps.sdl2 kivy.deps.glew
#python -m pip install kivy.deps.gstreamer
#python -m pip install kivy.deps.angle
python -m pip install kivy

インストールが終わったら,

pip list

と入力し, Kivy がインストールされていることを確認します.

*コメントアウトした行について

#python -m pip install kivy.deps.gstreamer

Kivyを使い始める

には, "Kivyには既にオーディオとビデオのプロバイダがありますが、より高度なものにはGStreamerが必要です。" と書いてあります. また, 動画プレイヤーも入っているらしいです. 私には必要なさそうなので入れませんでした.

#python -m pip install kivy.deps.angle

Kivy Windows Hello Worldへの道 真っ黒画面

には, "OpenGl ESのDirectX実装" と書いてあります. 必要かどうかわからないので, 必要になった時点で入れれば良いのだろうと思います.

4. Kivy のエラー対策

Windows で kv ファイルを読み込む際にエラーが出るようなので,

C:\Users\ユーザー名\AppData\Local\Programs\Python\Python37-32\Lib\site-packages\kivy\lang\

の (環境やバージョンによって場所は違うはず) builder.py を変更します.

if __debug__:
trace('Lang: load file %s' % filename)
with open(filename, 'r') as fd:
kwargs['filename'] = filename
data = fd.read()

の

with open(filename, 'r') as fd:

を

with open(filename, 'r', encoding='utf8') as fd:

に書き換えます.

5. PyInstaller をインストール (使用する場合)

python -m pip install pyinstaller

と入力し, 終了後,

pip list

と入力し, インストールされていることを確認します.

6. Nuitka をインストール (使用する場合)

python -m pip install nuitka

と入力し, 終了後,

pip list

と入力し, インストールされていることを確認します.

作製編 へ続きます.

参考ページ

MinGW-w64 を導入する − しっぽのさきっちょ
MinGW-w64のダウンロードとインストール | C言語入門
Python3のインストール
Installation on Windows(翻訳済み) − Kivy 1.10.0 ドキュメント
Kivy を Windows で動作させると UnicodeDecodeError が発生する場合の対処方法