LoginSignup
1
2

More than 3 years have passed since last update.

Pythonを使って、Jupyter Notebookのテンプレートを作るCLIツールを作成した

Last updated at Posted at 2020-03-09

3行で。

  • Notebookのテンプレートを作成するツール『notelate』を作成しました。
  • pip install notelateでインストール。
  • notelate [template name]でカレントディレクトリにipynbファイルが生成されます。

動機

Jupyter Labをよく使用するのですが、毎回import pandas as pdなどと書くのが非常に面倒でした。
テンプレートを用意してコピペで増やすことで対応していました。

検索すると、Jupyterlabのアドインが公開されていました。(jupyterlab_templates)
しかし、自らテンプレートを登録する必要があり、面倒でした。

そこで、テンプレートをシェアできる機能をもたせたツールを作ろうと思いました。

使い方

インストール

pip環境下で以下を入力することでインストールされます。
pip install notelate

使用する

テンプレートの生成

以下のコマンドでカレントディレクトリにipynbファイルが生成されます。template nameを入力しない場合は非常に簡単なbasic.ipynbが生成されます。
notelate [template name]

テンプレートの確認

以下のコマンドで使用可能なテンプレートを確認できます。
notelate list

参考にしたもの

以下の2記事を主に参考にしました。
PythonでサクッとCLIツールを作る
PyPIデビューしたい人の為のPyPI登録の手順
公式ドキュメント

Pythonのコード自体はファイルをコピーするだけですので、割愛しますが、PyPIのためのsetup.pyが一番大変でした。
Githubにコードはありますので、ご覧いただければと思います。
ツール自体は1時間で作成し、PyPIの手続きで2時間ほどかかりました。

さいごに

読んでいただきありがとうございました。
想像していたよりも簡単にツールの作成やPyPIへの登録や公開が完了し、驚きました。

コードはGithub上にありますので、スターやプルリクいただけると嬉しいです。
Githubリポジトリ: notelate
PyPI: notelate

1
2
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
2