PyCharmでPlantUMLを使用する方法

PyCharmでPlantUMLを使用する方法をご紹介します。

1 条件
2 PlantUMLとは？
3 プラグインのインストール
4 Graphvizのインストール
- 4.1 クライアントPCへのインストール
- 4.2 PyCharmでの設定
5 UMLの作成
- 5.1 シーケンス図作成
6 参考
- 6.1 PlantUML integration
- 6.2 Graphviz – Graph Visualization Software

条件

PyCharm

PlantUMLとは？

オープンソースのUMLダイアグラム作成用のテキストベースの言語です。

（出典：ウィキペディア）

プログラムを記述する感覚で様々なUML図を作成することが出来ます。

プラグインのインストール

PyCharmメニューのファイル > 設定を選択します。

設定画面が開くので、左メニューで「プラグイン」を選択して画面下の方の「リポジトリーの参照…」ボタンを押します。

リポジトリーの参照画面が開くので、検索入力フィールドに「plant」を入力します。
「PlantUML Integration」が候補として挙がるので、緑色のインストールボタンを押します。

Third-party Plugins Privacy Noteダイアログが表示されます。
許諾ボタンを押します。

インストール完了後、リポジトリーの参照画面を閉じます。
設定画面に「PlantUML integration」が追加されていることを確認してOKボタンを押して閉じます。

プラグインの変更を有効にするためにPyCharmを再開しますか？と聞かれるので、再開ボタンを押します。
⇒PyCharmが再起動します。

以上でプラグインの追加は完了です。

Graphvizのインストール

UML図の表示にはGraphvizを使用します。
Graphvizは別途インストールする必要があります。

以下のサイトからGraphvizのインストーラをダウンロードします。
http://www.graphviz.org/download/

Windowsの「Stable 2.38 Windows install packages」を選択します。

画面が切り替わります。
「graphviz-2.38.msi」を選択します。

クライアントPCへのインストール

ダウンロードしたインストーラ（graphviz-2.38.msi）をダブルクリックして起動します。
インストーラの流れに沿ってインストールを実行します。

PyCharmでの設定

PyCharmメニューのファイル > 設定を選択して設定画面を開きます。
設定画面の左メニューでPlantUMLを選択します。
Graphviz dot executable:の参照で、先ほどインストールしたGraphvizのdot.exeを選択します。
（C:/Program Files (x86)/Graphviz2.38/bin/dot.exe）