【Python】pyinstallerの使い方。実行ファイル(exe化)して誰でも使用できるようにする方法。

この記事ではpyinstallerの使い方についてまとめます。

OSはWindowsを使用していることを前提としています。

とにかくすぐにでも実行ファイルを作成したい場合は、前半の手順1を、なるべく動作を早くしたい場合は手順2(仮想環境の利用)をご覧ください。

 

Pyinstallerでできること

pyinstallerを使うと実行ファイルの作成(exe化)ができます。

作成された実行ファイルを配布することで、Pythonがインストールされていない端末でも使用できます。

他のライブラリでは複数のファイルが作成されるが、pyinstallerでは1つのファイルにまとめることができます

実行ファイル作成(exe化)の手順

 

pyinstallerのインストール

pyinstallerをインストール。

 

.pyファイルのあるフォルダへ移動

.pyファイルのあるフォルダに事前に移動しておきます。

例えばpythonのスクリプトをデスクトップに置いている場合は、デスクトップに移動する。

 

実行ファイルの作成

Pythonは起動せずに上記のコマンドを入力します。

“–onefile”はオプションです。

実行に必要なものを全て1つにまとめることで、実利用者には.exeファイルのみ渡すことで使用できます。

1つにまとめなくても良い場合は使用する必要はありませんが、.exeファイルだけでなく、他の作成されたファイルも一緒に渡しておく必要があります。

pyinstallerには他にもオプションがありますがここでは割愛します。

 

実行後は数分ほど待ちましょう。

実行後、複数のフォルダが作成されますが、実行ファイルは「dist」というフォルダの中に作成されています。

これを実利用者に渡せば完了です。

後は必要に応じてダブルクリックで実行してもらうのみです。

 

動作を軽くしたい場合

仮想環境で必要十分なライブラリのみを使用して作成

 

pyinstallerは、現在の環境にインストール済みのライブラリをすべて実行ファイルの中に含めてしまいます。

様々なライブラリをインストールしている場合は、実行ファイルには不要なライブラリも含まれてしまい、動作が重くなってしまう原因になります。

そこで、仮想環境を用いて必要最低限のライブラリだけをインストールすることで、不要なライブラリを含まない実行ファイルを作成します。

 

仮想環境の作成

venvを使って仮想環境を作成します。

仮想環境と言っても、単純にどこかにフォルダを1つ作り、その中にPythonとライブラリを用意するというイメージで良いです。

 

デスクトップに作成したい場合はデスクトップまでのパスを記入して実行します。

 

一例としてデスクトップに作成する場合を考えます。

デスクトップに仮想環境(実際には単なるフォルダ)を作成します。

“仮想環境名”は自由に付けることができます。

実行するとデスクトップに”仮想環境名”で指定した名前のフォルダが作成されます。

 

仮想環境のフォルダの内部には、複数のフォルダとファイルが作成されているので、そのうちの”Scripts”というフォルダに移動します。

 

Scriptsというフォルダの中で”Activate”と入力して実行します。

これで仮想環境を起動することができます。

 

以下↓のように先頭に(仮想環境名)と表示されていれば仮想環境の起動が完了しました。

 

この後、必要なライブラリを用意します。

 

ライブラリのインストール

 

仮想環境を起動した状態で、pip installを行っていきます。

 

この時、pyinstallerを必ずインストールしておきましょう。

恐らく、仮想環境内でpyinstallerをインストールしていない場合、本体のPython環境(いわゆるバニラPython)内にインストールされているpyinstallerを使用してしまいます。

仮想環境ではない本体のPython環境には、今回実行ファイルにしたいスクリプトでは使用していないライブラリがインストール済なので、仮想環境を作成したにも関わらず、結局不要なライブラリを含めた実行ファイルを作成してしまい、動作が重くなる原因になります。

 

実行ファイルを作成

仮想環境を起動していればどこのフォルダでも良いですが、.pyファイルを置いている場所で実行ファイルを作成するコマンドを実行します。

※ここではScriptsフォルダで実行していますが、この場合はScriptsフォルダ内に.pyファイルを置いておく必要があります。

 

まとめ

この記事ではpyinstallerを使った実行ファイルの作成方法をまとめました。

py2exeやnuitkaのように他の方法でも実行ファイルを作成することができますが、1つのファイルにまとめて作成できることはpyinstallerの利点です。