インストール

前提条件

  • xlwingsはExcelのインストールを前提としているため、WindowsとmacOSでしか動作しません。また、macOSでは現在UDFをサポートしていません。

  • xlwingsはPython 3.6以上で動作します。

Pythonバージョンとそれに対応する最後のxlwingsのバージョンの関係は次のとおり

  • Python 3.5: 0.19.5

  • Python 2.7: 0.16.6

インストール

xlwingsは以下のディストリビューションに含まれます

  • Anaconda (Windows and macOS)

  • WinPython (Windowsのみ) Pythonしか含まれない dot バージョンを 使用しない こと

Pythonを初めて使う場合や、xlwingsのインストールでトラブルが起きる場合には、上記いずれかのディストリビューションの利用を強く推奨します。それ以外には、pipを使って手動でインストールすることもできます:

pip install xlwings

もしくはcondaで:

conda install xlwings

公式の conda からインストールしたパッケージは少し前にリリースされたバージョンの場合があります。その場合、 conda-forge チャネルを使いましょう(xlwingsがインストール済みなら installupgrade に置き換えて下さい):

conda install -c conda-forge xlwings

注釈

macOS上で、 conda でxlwingsをインストールしている(または、Anacondaに含まれているxlwingを使用している)場合、一度 $ xlwings runpython install を実行し、VBAから RunPython を呼び出せるようにしてください。なお、 & xlwings addin install でアドインをインストールした場合には不要です。

アドイン

アドインをインストールするには、以下のコマンドを実行します:

xlwings addin install

PythonからのExcelの呼び出しにはアドインは不要です。また、アドインの代わりに単独のVBAモジュール(スタンドアローンのワークブック)を使うこともできます。詳細は アドインおよび設定 をご覧ください。

注釈

アドインはPythonのパッケージと同じバージョンでなければなりません。xlwingsのパッケージをアップデートした際は、アドインの再インストールも忘れないようにしてください。

依存関係

  • Windows: pywin32

  • Mac: psutil, appscript

Windowsでは、condapip でxlwingsをインストールすれば依存関係は自動的に解決されます。

xlwings PROを使うには

xlwings PROは additional functionality を提供します。ドキュメントではPRO機能に xlwings PRO と記載しています。

注釈

xlwings PROの追加的な機能を利用するには、ライセンスキーの取得とxlwings v0.19.0以上であることが必要になります。 xlwings.pro サブパッケージの全てのものは、 commercial license となっています。詳細は xlwings PRO Overview をご覧ください。

ライセンス キーを有効化するには、以下のコマンドを実行してください:

xlwings license update -k LICENSE_KEY

LICENSE_KEY をあなたが取得したキーに置き換えてください。このコマンドで、ホームフォルダーの xlwings.conf ファイル(保存場所は、 ユーザー設定: リボン/Config ファイル を参照してください)に、ライセンス キーを保存します。もしくは、 XLWINGS_LICENSE_KEY という名前の環境変数にライセンス キーを保存することもできます。

xlwings PROの利用には、 cryptography パッケージと Jinja2 パッケージも必要になりますが、AnacondaとWinPythonには初めからインストールされています。Anacondaを使っていなければ、pipまたはcondaでインストールします。

pipを使う場合には、 pip install "xlwings[pro]" を実行することで、xlwings PRO向けの追加的な依存関係を解決できます。

必須ではない依存関係

  • NumPy

  • Pandas

  • Matplotlib

  • Pillow/PIL

  • Flask (for REST API)

  • cryptography (for xlwings.pro)

  • Jinja2 (for xlwings.pro.reports)

  • requests (for permissioning)

これらのパッケージは必須ではありませんが、xlwingsと強力に連携することからインストールを強く推奨します。これらは全てAnacondaに初めからインストールされています。pipの場合、これらを含めてxlwingsをインストールするには、次のようにします:

pip install "xlwings[all]"

アップデート

xlwingsを最新バージョンにアップデートするには、コマンド プロンプトで以下を実行します:

pip install --upgrade xlwings

もしくは:

conda update -c conda-forge xlwings

ExcelアドインのバージョンはPythonパッケージのバージョンと同期させてください。同期するには、Excelを閉じた上で以下を実行します:

xlwings addin install

アンインストール

xlwingsをアンインストールするには、初めにアドインをアンインストールしてください。次に、インストールと同じ方法(pipまたはconda)で、xlwingsパッケージをアンインストールしてください。

xlwings addin remove

続いて

pip uninstall xlwings

もしくは:

conda remove xlwings

Finally, manually remove the .xlwings directory in your home folder if it exists.