PyInstallerの使い方を解説

Pythonプログラムをexe化する際に使用するPyInstaller。

この記事では、PyInstallerを使ってPythonプログラムをexe化する方法について解説していきます。

pyinstallerとは

pyinstallerとは、Pythonプログラムを実行可能な単一の実行ファイルに変換するためのツールです。

Pythonのスクリプトを他のユーザーに配布する際に便利です。

pyinstallerの特徴

pyinstallerの特徴は以下の通りです。

• クロスプラットフォーム対応：Windows、Mac、Linuxなど、さまざまなプラットフォームで実行ファイルを生成できます。
• 自己完結型実行ファイル：Pythonのインストールが不要で、単一の実行ファイルとして配布できます。
• 依存関係の解決：Pythonの依存関係を自動的に解決し、必要なライブラリやモジュールを実行ファイルに組み込むことができます。
• カスタマイズ可能：ビルドオプションを設定することで、実行ファイルの動作や外部リソースの組み込みなどをカスタマイズできます。

pyinstallerのインストール方法

pyinstallerはPythonのパッケージであり、Pythonスクリプトを実行可能なバイナリファイルに変換するためのツールです。

pyinstallerをインストールするには、以下の手順に従ってください。

1. pipを使用してpyinstallerをインストールします。

ターミナルまたはコマンドプロンプトを開き、以下のコマンドを実行します。

pip install pyinstaller

2. インストールが完了したら、pyinstallerコマンドが使用できるようになります。

以下のコマンドを実行して、pyinstallerのバージョンを確認してみましょう。

pyinstaller --version

3. もしpyinstallerが正しくインストールされていれば、バージョン番号が表示されます。

バージョン番号が表示されず、エラーが出た場合はPyInstallerのインストールの何処かで問題が発生しています。

Pythonバージョンなどが原因である可能性があるので、インストール出来ない場合はこちらを参考にしてください。

あわせて読みたい

PyInstallerをインストールできない場合の対処法 PyInstallerはPythonプログラムをexe化する際に欠かせないツールですが、そもそもPyInstallerのインストールの段階でつまずいている人もいるのではないでしょうか。 こ…

以上で、pyinstallerのインストールが完了しました。

pyinstallerの基本的な使い方

シンプルなPythonスクリプトの実行ファイル化

pyinstallerを使うと、Pythonスクリプトを実行ファイルに変換することができます。

まずは、シンプルなPythonスクリプトを実行ファイル化する手順を見ていきましょう。

1. ターミナルを開き、pyinstallerコマンドを実行します。

以下のようなコマンドを入力します。

pyinstaller script.py

ここで、script.pyは実行ファイル化したいPythonスクリプトのファイル名です。

2. pyinstallerは自動的に実行ファイルを生成します。

生成された実行ファイルは、distディレクトリ内に保存されます。

3. distディレクトリ内に生成された実行ファイルを実行すると、Pythonスクリプトが実行されます。

生成されたexeファイルはPython開発環境に依存しないため、別のデバイスでも実行することが可能です。

パッケージ化と依存関係の解決

Pythonスクリプトが外部ライブラリに依存している場合、pyinstallerは自動的にそれらの依存関係を解決して実行ファイルにパッケージ化することができます。

以下の手順で実行してみましょう。

1. ターミナルを開き、pyinstallerコマンドを実行します。

以下のようなコマンドを入力します。

pyinstaller script.py

オプションは必要ありません。

2. pyinstallerは自動的に依存関係を解決し、実行ファイルを生成します。
3. 生成された実行ファイルを実行すると、Pythonスクリプトが実行されます。

このとき、外部ライブラリに依存している場合でも、実行ファイル内にそれらのライブラリが含まれているため、別途インストールする必要はありません。

コマンドラインオプションの活用

pyinstallerには、さまざまなコマンドラインオプションが用意されています。

これらのオプションを活用することで、実行ファイルの動作やビルドの設定をカスタマイズすることができます。

例えば、以下のようなコマンドを実行することで、実行ファイルのアイコンを指定することができます。

pyinstaller --icon=icon.ico script.py

ここで、icon.icoは実行ファイルのアイコンとして使用するアイコンファイルのパスです。pngやjpg形式のままでは使えませんので、必ずico形式に変換しておきましょう。

ビルドオプションの設定

pyinstallerでは、ビルドオプションを設定することで、実行ファイルのビルド時の動作をカスタマイズすることができます。

例えば、以下のようなビルドオプションを指定することで、実行ファイルを1つのファイルにまとめることができます。

pyinstaller --onefile script.py

このオプションを指定すると、生成される実行ファイルは1つのファイルにまとめられます。

依存関係のあるファイルもすべて実行ファイル内に含まれるため、実行ファイルを単体で配布することができます。

あわせて読みたい

PyInstallerのオプション”–onefile”の使い方 PyInstallerにはさまざまなオプションがありますが、その中でも使う機会が多いオプションの1つが–onefile。 この記事では、Pythonのプログラムを単一の実行可能ファイ…

また、他にもさまざまなビルドオプションが用意されていますので、必要に応じて適切なオプションを指定してビルドしてください。

以上が、pyinstallerの基本的な使い方です。