【PyInstaller】バージョン情報を生成する方法

この記事では、PyInstallerを使用してPythonプログラムにバージョン情報を含める方法について解説します。

初心者の方でも簡単に理解できるように、pyinstaller-versionfileのインストール方法から、YAMLファイルの作成、バージョンファイルへの変換、そしてPyInstallerを使用した実行可能ファイルの生成まで、手順を詳しく説明します。

バージョン情報を含んだ実行可能ファイルを作成することで、ソフトウェアのバージョン管理やユーザーへの情報提供が容易になります。

目次から探す

バージョン情報の生成方法

バージョン情報は、ソフトウェアの開発や管理において重要な要素です。

PyInstallerを使用してPythonプログラムを実行可能ファイルに変換する際にも、バージョン情報を含めることができます。

本記事では、PyInstallerを使用してバージョン情報を生成する方法について解説します。

pyinstaller-versionfileを使用する

PyInstallerでは、バージョン情報を生成するために、pyinstaller-versionfileというツールを使用することができます。

このツールを使うことで、簡単にバージョン情報を含んだ実行可能ファイルを作成することができます。

pyinstaller-versionfileのインストール

まずはじめに、pyinstaller-versionfileをインストールする必要があります。

以下のコマンドを使用して、pipを使ってインストールします。

pip install pyinstaller-versionfile

YAMLファイルの作成

次に、バージョン情報を記述するためのYAMLファイルを作成します。

YAMLファイルは、人間にとって読みやすく、機械にとっても解析しやすいデータ形式です。

以下のような形式で、バージョン情報を記述したYAMLファイルを作成します。

Version: 1.0.0
CompanyName: Personal
FileDescription: サンプルソフトウェア
InternalName: Sample Program
LegalCopyright: © 2023 CodeStream
OriginalFilename: sampleAPP.exe
ProductName: SAMPLE

バージョンファイルに変換

YAMLファイルをバージョンファイルに変換するために、pyinstaller-versionfileコマンドを使用します。

以下のコマンドを実行して、YAMLファイルをバージョンファイルに変換します。

create-version-file version.yaml --outfile sample.version

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

このファイルには、YAMLファイルで指定したバージョン情報がPythonの辞書形式で格納されています。

PyInstallerの実行

最後に、PyInstallerを使用して実行可能ファイルを生成します。

以下のコマンドを実行して、Pythonプログラムを実行可能ファイルに変換します。

pyinstaller sample.py --version-file=sample.version

このコマンドを実行すると、main.pyというPythonプログラムを実行可能ファイルに変換します。

生成された実行可能ファイルには、バージョン情報が含まれています。

以上が、PyInstallerを使用してバージョン情報を生成する方法です。