【cx_Freeze】使用できるオプション一覧

2023-11-172023-12-08

cx_FreezeはPythonのパッケージングツールであり、この記事ではcx_Freezeで使用できるオプションについて解説します。

目次から探す

cx_Freezeで使用できるオプション

cx_FreezeはPythonのパッケージングツールであり、様々なオプションを指定することでパッケージの詳細な設定を行うことができます。

以下にcx_Freezeで使用できるオプションについて説明します。

name

パッケージの名前を指定する文字列です。

このオプションを使用することで、パッケージの識別子を設定することができます。

version

パッケージのバージョン番号を指定する文字列です。

バージョン番号は、パッケージの更新や変更を追跡するために使用されます。

description

パッケージを1行で説明する文字列です。

このオプションを使用することで、パッケージの概要を簡潔に表現することができます。

long_description

パッケージの詳細な説明を提供する文字列です。

このオプションを使用することで、パッケージの詳細な機能や使い方について説明することができます。

long_description_content_type

long_descriptionのコンテンツタイプを指定する文字列です。

例えば、text/markdownと指定することで、Markdown形式で記述された説明文を表示することができます。

author

パッケージの作成者を指定する文字列です。

このオプションを使用することで、パッケージの作者を明示することができます。

author_email

パッケージ作成者の電子メールアドレスを指定する文字列です。

このオプションを使用することで、パッケージ作成者との連絡を取るための連絡先を提供することができます。

maintainer

現在のメンテナの名前を指定する文字列です。

作成者と異なる場合に使用します。

メンテナが提供されている場合、setuptoolsはそれを作成者として使用します。

maintainer_email

現在のメンテナの電子メールアドレスを指定する文字列です。

作成者と異なる場合に使用します。

url

パッケージのホームページのURLを指定する文字列です。

このオプションを使用することで、パッケージの公式ウェブサイトへのリンクを提供することができます。

download_url

パッケージをダウンロードするためのURLを指定する文字列です。

このオプションを使用することで、パッケージのダウンロードリンクを提供することができます。

options

セットアップスクリプトのデフォルトオプションを提供する辞書です。

このオプションを使用することで、パッケージのビルドやインストールに関する設定を行うことができます。

license

パッケージのライセンスを指定する文字列です。

このオプションを使用することで、パッケージの使用条件や制約を明示することができます。

license_files

含める必要があるライセンス関連ファイルのglobパターンのリストです。

このオプションを使用することで、パッケージに関連するライセンスファイルを自動的に含めることができます。

keywords

説明的なメタデータを提供する文字列のリストまたはカンマ区切りの文字列です。

このオプションを使用することで、パッケージの特徴や用途をキーワードで表現することができます。

project_urls

URL名のハイパーリンクへの任意のマップです。

これにより、さまざまなリソースがどこにあるかについて、単純なオプションで提供されるものよりも拡張可能なドキュメントが可能になります。

以上がcx_Freezeで使用できるオプションの一覧です。

これらのオプションを適切に設定することで、パッケージの詳細な情報や設定を指定することができます。

各種オプションを使用したサンプルコード

以下は、cx_Freezeで使用できるオプションを使ったサンプルコードの例です。

from cx_Freeze import setup, Executable
# パッケージの情報を設定する
options = {
    'name': 'MyPackage',
    'version': '1.0.0',
    'description': 'Sample Program',
    'author': 'Exam ple',
    'author_email': '[email protected]',
    'url': 'https://example.com/mypackage',
    'license': 'MIT',
    'keywords': ['python', 'package'],
    'options': {
        'build_exe': {
            'include_files': ['data.txt'],
            'excludes': ['tkinter'],
            'optimize': 2
        }
    },
    'executables': [Executable('main.py')]
}
# セットアップを実行する
setup(options)

上記のコードでは、setup関数を使用してパッケージの情報とオプションを設定しています。