MENU
  1. ホーム
  2. Python
  3. ツール
  4. PyInstallerの使い方を解説

PyInstallerの使い方を解説

ツール

この記事では、Pythonで作成したプログラムを簡単に実行可能なアプリケーションに変換するためのツール PyInstaller について詳しく解説します。

PyInstallerの基本的な使い方やインストール方法、設定ファイルの活用法、実際のアプリケーションの変換例を紹介します。

目次から探す

PyInstallerとは

PyInstallerは、Pythonで書かれたプログラムをスタンドアロンの実行可能ファイルに変換するためのツールです。

これにより、Pythonがインストールされていない環境でも、作成したアプリケーションを実行できるようになります。

特に、デスクトップアプリケーションやコマンドラインツールを配布する際に非常に便利です。

PyInstallerの概要

PyInstallerは、Pythonのスクリプトを解析し、必要なライブラリやリソースを収集して、単一の実行ファイルまたはフォルダ形式のアプリケーションを生成します。

これにより、ユーザーはPythonの環境を気にせずにアプリケーションを使用できるようになります。

PyInstallerは、Windows、macOS、Linuxの各プラットフォームで動作します。

PyInstallerの特徴

特徴説明
クロスプラットフォーム対応Windows、macOS、Linuxの各OSで動作し、同じPythonコードから異なるプラットフォーム用の実行ファイルを生成できます。
簡単なコマンドラインインターフェースPyInstallerは、コマンドラインから簡単に使用できるため、特別な設定や複雑な手順なしでアプリケーションをビルドできます。
多様な出力形式単一の実行ファイル(–onefileオプション)や、複数のファイルを含むフォルダ形式で出力することができます。
外部ライブラリのサポートNumPyやPandasなどの外部ライブラリを使用したアプリケーションも、問題なくパッケージ化できます。

PyInstallerの利点と欠点

利点

  1. 配布の簡便さ: Pythonがインストールされていない環境でもアプリケーションを実行できるため、配布が容易です。
  2. 依存関係の自動処理: 必要なライブラリやリソースを自動的に収集し、実行ファイルに含めるため、手動での設定が不要です。
  3. カスタマイズ性: specファイルを使用することで、ビルドプロセスを細かくカスタマイズできます。

欠点

  1. ファイルサイズの増加: 単一ファイルで出力する場合、実行ファイルのサイズが大きくなることがあります。

これは、必要なライブラリやリソースがすべて含まれるためです。

  1. ビルド時間: 大規模なアプリケーションや多くの依存関係がある場合、ビルドに時間がかかることがあります。
  2. 特定の環境依存: 一部のライブラリや機能は、特定のプラットフォームでのみ動作する場合があり、クロスプラットフォームでの動作が保証されないことがあります。

PyInstallerは、Pythonプログラムを配布する際に非常に便利なツールですが、利点と欠点を理解した上で使用することが重要です。

次のセクションでは、PyInstallerのインストール方法について詳しく解説します。

PyInstallerのインストール

PyInstallerを使用するためには、まず必要な環境を整え、インストールを行う必要があります。

以下では、必要な環境、インストール手順、そしてインストールが正しく行われたかを確認する方法について解説します。

必要な環境

PyInstallerを使用するためには、以下の環境が必要です。

  • Python: PyInstallerはPython 3.5以降のバージョンに対応しています。

最新の安定版を使用することをお勧めします。

  • pip: Pythonのパッケージ管理ツールであるpipがインストールされている必要があります。

通常、Pythonをインストールするとpipも自動的にインストールされます。

  • OS: PyInstallerはWindows、macOS、Linuxの各プラットフォームで動作しますが、特定のOSに依存する機能もあるため、使用するOSに応じた注意が必要です。

インストール手順

PyInstallerのインストールは非常に簡単です。

以下の手順に従ってください。

  1. コマンドラインを開く: Windowsでは「コマンドプロンプト」、macOSやLinuxでは「ターミナル」を開きます。
  2. pipを使用してPyInstallerをインストール: 以下のコマンドを入力して実行します。 
pip install pyinstaller

このコマンドを実行すると、PyInstallerが自動的にダウンロードされ、インストールされます。

  1. インストールの進行状況を確認: インストール中に、必要なパッケージがダウンロードされ、インストールされる様子が表示されます。

特にエラーが表示されなければ、インストールは成功です。

インストール確認

PyInstallerが正しくインストールされたかを確認するためには、以下の手順を行います。

  1. コマンドラインを開く: 再度、コマンドプロンプトまたはターミナルを開きます。
  2. PyInstallerのバージョンを確認: 以下のコマンドを入力して実行します。 
pyinstaller --version

正常にインストールされていれば、PyInstallerのバージョン番号が表示されます。

例えば、以下のような出力が得られます。

4.5.1

もしエラーメッセージが表示された場合は、インストールが正しく行われていない可能性があります。

その場合は、再度インストール手順を確認し、必要に応じてPythonやpipのインストール状況を見直してください。

以上で、PyInstallerのインストールが完了し、使用する準備が整いました。

次のステップでは、PyInstallerの基本的な使い方について解説します。

PyInstallerの基本的な使い方

PyInstallerを使ってPythonスクリプトを実行可能なファイルに変換する方法を見ていきましょう。

基本的なコマンドを使って、シンプルにアプリケーションを生成することができます。

シンプルなコマンドでの実行

PyInstallerを使う際の基本的なコマンドは非常にシンプルです。

以下のコマンドをターミナルやコマンドプロンプトで実行することで、Pythonスクリプトを変換できます。

単一ファイルの生成

単一ファイル形式でアプリケーションを生成するには、以下のコマンドを使用します。

pyinstaller --onefile your_script.py

ここで、your_script.pyは変換したいPythonスクリプトのファイル名です。

このコマンドを実行すると、distフォルダ内に実行可能な単一ファイルが生成されます。

例えば、hello.pyというスクリプトが以下の内容だとします。

print("Hello, World!")

このスクリプトを単一ファイルに変換するには、次のようにコマンドを実行します。

pyinstaller --onefile hello.py

実行後、distフォルダ内にhelloという実行ファイルが生成されます。

このファイルをダブルクリックすることで、コンソールに Hello, World! と表示されるのを確認できます。

フォルダ形式の生成

フォルダ形式でアプリケーションを生成する場合は、以下のコマンドを使用します。

pyinstaller your_script.py

このコマンドを実行すると、distフォルダ内にyour_scriptという名前のフォルダが生成され、その中に実行ファイルや必要なライブラリが格納されます。

例えば、hello.pyをフォルダ形式で生成するには、次のようにコマンドを実行します。

pyinstaller hello.py

この場合、dist/helloフォルダ内に実行ファイルや依存ファイルが含まれます。

フォルダ形式は、複数のファイルやリソースを含むアプリケーションに適しています。

オプションの使い方

PyInstallerには、さまざまなオプションを指定することができます。

これにより、生成されるアプリケーションの動作や外観をカスタマイズできます。

–onefileオプション

--onefileオプションは、前述の通り、単一の実行ファイルを生成するために使用します。

このオプションを指定しない場合、フォルダ形式で生成されます。

–windowedオプション

GUIアプリケーションを作成する場合、コンソールウィンドウを表示させたくないことがあります。

その場合は、--windowedオプションを使用します。

pyinstaller --onefile --windowed your_script.py

このコマンドを実行すると、GUIアプリケーションがコンソールウィンドウなしで起動します。

例えば、Tkinterを使ったアプリケーションなどで便利です。

–iconオプション

アプリケーションにアイコンを設定したい場合は、--iconオプションを使用します。

アイコンファイルは.ico形式で指定する必要があります。

pyinstaller --onefile --icon=your_icon.ico your_script.py

このコマンドを実行すると、生成される実行ファイルに指定したアイコンが設定されます。

これにより、アプリケーションの見た目をカスタマイズすることができます。

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

これらのコマンドやオプションを活用することで、Pythonスクリプトを簡単に実行可能なアプリケーションに変換することができます。

次のセクションでは、PyInstallerの設定ファイルについて詳しく見ていきましょう。

PyInstallerの設定ファイル

PyInstallerを使用する際、特に複雑なアプリケーションを作成する場合、設定ファイルであるspecファイルを利用することが重要です。

このセクションでは、specファイルの概要、生成方法、編集方法について詳しく解説します。

specファイルの概要

specファイルは、PyInstallerがアプリケーションをビルドする際の設定を記述するためのファイルです。

このファイルには、アプリケーションのエントリーポイント、依存関係、データファイル、パッケージの設定などが含まれています。

specファイルを使用することで、より柔軟にアプリケーションのビルドプロセスをカスタマイズできます。

specファイルの生成

specファイルは、PyInstallerを使って簡単に生成できます。

以下のコマンドを実行することで、指定したPythonスクリプトに基づいてspecファイルが作成されます。

pyinstaller your_script.py

このコマンドを実行すると、your_script.specというファイルが生成されます。

このファイルは、同じディレクトリ内に保存されます。

specファイルの編集方法

生成されたspecファイルは、テキストエディタで開いて編集することができます。

以下に、specファイルの編集方法について詳しく説明します。

データファイルの追加

アプリケーションが必要とするデータファイル(画像、設定ファイルなど)をspecファイルに追加することができます。

以下のように、datasリストにデータファイルを追加します。

a = Analysis(['your_script.py'],
             pathex=['.'],
             binaries=[],
             datas=[('data_file.txt', '.'), ('image.png', 'images')],
             ...

上記の例では、data_file.txtをアプリケーションのルートに、image.pngをimagesフォルダに追加しています。

パッケージの設定

特定のパッケージを含める必要がある場合、specファイルのhiddenimportsリストにパッケージ名を追加します。

例えば、numpyやpandasなどの外部ライブラリを含める場合は、以下のように記述します。

a = Analysis(['your_script.py'],
             ...
             hiddenimports=['numpy', 'pandas'],
             ...

この設定により、PyInstallerは指定したパッケージをアプリケーションに含めることができます。

次のセクションでは、PyInstallerを使った実践例について解説します。

PyInstallerを使った実践例

簡単なPythonスクリプトの変換

まずは、非常にシンプルなPythonスクリプトをPyInstallerを使って変換してみましょう。

以下のような内容のスクリプトを作成します。

# hello.py
print("Hello, World!")

このスクリプトは、実行すると Hello, World! と表示されるだけのものです。

次に、このスクリプトをPyInstallerを使って実行可能なファイルに変換します。

コマンドラインで以下のコマンドを実行します。

pyinstaller --onefile hello.py

このコマンドを実行すると、distフォルダ内にhello.exe(Windowsの場合)またはhello(Linux/Macの場合)が生成されます。

このファイルをダブルクリックすることで、スクリプトが実行され、 Hello, World! と表示されることを確認できます。

GUIアプリケーションの変換

次に、簡単なGUIアプリケーションを作成し、それをPyInstallerで変換してみましょう。

以下は、Tkinterを使った簡単なGUIアプリケーションの例です。

# gui_app.py
import tkinter as tk
def greet():
    print("Hello, GUI World!")
app = tk.Tk()
app.title("My GUI App")
greet_button = tk.Button(app, text="Greet", command=greet)
greet_button.pack()
app.mainloop()

このアプリケーションは、ボタンをクリックすると Hello, GUI World! と表示されるものです。

このスクリプトをPyInstallerで変換するには、以下のコマンドを実行します。

pyinstaller --onefile --windowed gui_app.py

--windowedオプションを使うことで、コンソールウィンドウを表示せずにアプリケーションを実行できます。

変換後、distフォルダ内に生成された実行ファイルをダブルクリックすると、GUIアプリケーションが起動します。

外部ライブラリを使用したアプリケーションの変換

最後に、外部ライブラリを使用したアプリケーションをPyInstallerで変換してみましょう。

ここでは、requestsライブラリを使った簡単なHTTPリクエストを行うスクリプトを作成します。

# fetch_data.py
import requests
response = requests.get('https://api.github.com')
print(response.json())

このスクリプトは、GitHubのAPIからデータを取得し、その内容を表示します。

このスクリプトをPyInstallerで変換するには、以下のコマンドを実行します。

pyinstaller --onefile fetch_data.py

外部ライブラリを使用している場合でも、PyInstallerは自動的に必要なライブラリを含めてくれます。

変換後、distフォルダ内に生成された実行ファイルを実行すると、GitHubのAPIから取得したデータが表示されることを確認できます。

これらの実践例を通じて、PyInstallerを使ったPythonスクリプトの変換方法を理解できたと思います。

PyInstallerを活用することで、Pythonで作成したアプリケーションを簡単に配布可能な形式に変換することができます。

目次に戻る

当サイトはリンクフリーです。出典元を明記していただければ、ご自由に引用していただいて構いません。

ツール

関連記事

目次から探す