Python
Jupyter
jupyter_contrib_nbextensions

Jupyter notebookのextensionを使ってオレオレPythonチートシートを作る

はじめに

最近Jupyter NotebookでPythonを書き始めたのですが、関数がどうしても覚えられなかったり、綺麗なコードの書き方を忘れてしまって、なんども調べることがありました。

Jupyter Notebookにはjupyter_contrib_nbextensionsという拡張機能があります。

その中にあるTable of Contentsという目次を自動的に作ってくれる機能を使って、日頃使う関数やコードをまとめたチートシートを作ろうと思います。

jupyter_contrib_nbextensionsとは

Jupyter Notebookの拡張機能を集めたものです。

ブラウザから様々な拡張機能のオンオフが出来ます。公式サイトはこちら

今回使うTable of Contents以外にも様々な機能があるので、興味のある方はこの記事などを参考に色々試してみると良いでしょう。

Table of Contentsとは

Jupyter_contrib_nbextensionの機能のうちの一つです。

Markdown記法に沿って、Jupyter notebookに目次をつけてくれます。

Markdown記法とは

手軽に文章を書くための言語です。

Markdown記法のサンプル集はここなどを参照。

インストールとアクティベーション

公式サイトに載っているやり方で進めていきます。

Jupyter notebookが起動してない状態で以下のコードを入力して下さい。

pip install jupyter_contrib_nbextensions
jupyter contrib nbextension install --user
jupyter nbextension enable codefolding/main
jupyter contrib nbextensions migrate

#拡張機能を止めたいときは、以下のコードを入力
#jupyter nbextension disable codefolding/main

これでインストール完了です。

インストール後にJupyterを起動すると、Nbextensionsというタブが現れます。

スクリーンショット 2017-12-22 23.35.34.png

ここをクリックすると、様々な拡張機能のオンオフが出来るようになります。

拡張機能の詳細は画面下部に表示されます。

スクリーンショット 2017-12-22 23.39.39.png

右下にあるTable of Contents(2)のチェックマークをクリックします。

チェックマークが付いていればアクティベーション完了です。

使い方

アクティベーションが終わった後に適当なnotebookを立ち上げると、以下のようなボタンが追加されているのがわかります。

スクリーンショット 2017-12-23 0.00.33.png

Markdown記法に沿ってnotebookを記入した後にこのボタンを押すと、自動で目次を作ってくれます。

目次を消したい時にはこのボタンをもう一回押します。

スクリーンショット 2017-12-23 0.06.17.png

スクロールすると目次が自動で移動したり、目次をクリックすると該当するセルへジャンプしたり、とても便利です。

後は、忘れやすい関数やよく使うコードなどを記入していけば、オレオレPythonチートシートの出来上がりです。

終わりに

オレオレPythonチートシートを作って、生産性を上げましょう。Enjoy!