PyCharmでプロジェクトの依存関係情報を作成する方法

PyCharmでプロジェクトの依存関係情報を作成する方法をご紹介します。

条件

• PyCharm Professional

setup.pyの作成

メニューのツール > setup.pyの作成 を選択します。

新規Setup Script作成ダイアログが開きます。
パッケージ名、バージョン等各種情報を入力してOKボタンを押します。

プロジェクトフォルダの下にsetup.pyが作成されます。

パッケージ要件ファイルの設定

メニューのファイル > 設定を選択して設定画面を開きます。
ツール > Python統合ツールを選択し、パッケージ要件ファイルに先ほど作成したsetup.pyを設定してOKボタンを押します。

未インストールパッケージの修正提案

パッケージ要件ファイル設定を行ったことにより、未インストールパッケージに対して修正提案が行われるようになります。
ソース上の未インストールパッケージをクリックします。
赤い電球マークが表示されるのでクリックします。
修正提案リストが開き、パッケージのインストールを行うことが出来ます。

requirements.txtの作成

コマンドラインで以下を実行することで要件ファイル（requirements.txt）を作成することが出来ます。
PyCharmの下部のターミナルを選択して以下のコマンドを実行します。

pip freeze > requirements.txt

プロジェクトフォルダの下にrequirements.txtが作成されます。

requirements.txtからパッケージのインストール

以下のコマンドを実行することで必要なパッケージを一括でインストールすることが出来ます。
PyCharmの下部のターミナルを選択してコマンドを実行します。

pip install -r requirements.txt

参考

setup.pyの作成と実行

https://pleiades.io/help/pycharm/creating-and-running-setup-py.html

requirements.txtの使用

https://pleiades.io/help/pycharm/managing-dependencies.html#create-requirements