Python

PythonでMarkdownを扱う -README.mdから実験メモ作成まで-

PythonでREADME.mdや実験メモを作成

こんにちは。

現役エンジニアの”はやぶさ”@Cpp_Learningです。README.mdから簡単なメモまで、Markdownで書くことが多いです。またPythonで色んなコードを書いてます。

本記事ではPythonでMarkdownを扱い、README.mdや実験メモを作成する方法を紹介します。

Markdownとは?READMEとは?

Markdownについては以下の記事で説明済みなので、本記事では割愛します。

Visual Studio Code でMarkdown
【仕事効率化】Visual Studio Code で Markdown を使いこなす【仕事効率化】Visual Studio Code(VSCode) で Markdown を使い自分用のメモやチートシート・Tips集などのドキュメント作成をキーボード1つで効率的に実施しよう!...

個人的にはMarkdownを使ってシンプルなREADME.mdを書くのが好きです。

READMEの書き方
【GitHub】シンプルなREADME.mdの書き方 -コピペで使えるテンプレート付き-こんにちは。 現役エンジニアの”はやぶさ”@Cpp_Learningです。 最近は、仕事でもプライベートでもREADME.m...

実践!PythonでMarkdownを扱う

PythonでMarkdownを扱う…といっても特に難しいことはありません。

下記 text のようにMarkdownで書いた文字列を *.md で保存するだけです。

まぁこれだとPython使うメリットが全くありませんが…

『プログラムの処理結果をMarkdownで書いて *.md で保存できる』と考えれば、色んなことに応用できます。

スポンサーリンク

実践!PythonとMarkdownでREADME.mdを作成する

*.mdをHTMLファイルに変換して展開したいケースもあるので、以下のコマンドで事前にライブラリをインストールしておきます。

pip install markdown

以降からコード書いていきます。

設定ファイル -info.json-

README.md テンプレートを参考に、”Name”や”Summary”などの情報を書いた設定ファイルを作成します。

この設定ファイルを本記事では info.json と名付けます。

作成したいREADMEに応じて、”Image_path”などを変更して下さい

PythonでREADME.mdとhtmlファイルを作成

README.md テンプレートの中でも頻繁に変更しない箇所なら、下記 TEMPLE のようにコードにべた書きするのもOKです。

このコードを実行すれば、 info.jsonTEMPLE に書いた情報を参照して、README.md と README.html を作成できます。

README.html

Pythonで作成した README.html を公開するので、自由に閲覧してください。htmlファイルなら、専用エディタ不要(ブラウザのみ)で情報共有できるのが嬉しいですね。

辞書から情報を参照するときは get を活用し、指定したkeyが存在しない場合にデフォルト値を返すようにしています。今回の場合、info.json に”Note”の情報が無いので、デフォルト値の”Nothing”をREADME.mdに書いています。

実践!Pythonと実験メモを作成する

続いてPythonで実験メモ(*.md)を作成します。今回は palmerpenguins(ペンギン データセット)を使いたいので、以下のコマンドでインストールします。

pip install palmerpenguins

以降からコード書いていきます。

設定ファイル -penguin_info.json-

先ほどと同様に設定ファイルを作成します。今回は penguin_info.json と名付けます。

Pythonで実験メモ(Markdown)を作成

pandasでデータを読込んで、基本統計量の演算など任意の処理をしたり、matplotlibでデータを可視化した画像を保存します。

その処理結果可視化画像をMarkdownで書き起こして、実験メモ(今回は penguin-visualization.md と名付ける)を作成するところまでを、Pythonコードのみで実施します。

ペンギンデータセットを可視化

設定ファイルの情報・上図・基本統計量を算出した表などをMarkdownで書き起こして作成した実験メモが以下です。

penguin-visualization

上記の実験メモですが、README.html 同様に ライブラリ でMarkdown ⇒ html変換したところ、表が上手く変換できなかったので、エディタ(VSCode)を活用して手動で変換させました。

pandas.DataFrame.to_markdownを使って、データフレームをMarkdownに変換

まとめ

PythonでMarkdownを扱う方法を紹介しました。

また応用として Pythonコードで、README.mdや実験メモを作成する方法も紹介しました。

プログラミングの面白さや便利さが少しでも伝わると嬉しいです。

はやぶさ
はやぶさ
役立つアプリや便利なライブラリを自作したり、使っている人は情報共有して頂けると嬉しいです。よろしくお願いします。

最後に『Pythonプログラミングを勉強したい!』という人のために、以下の記事を紹介します。

ゼロから学ぶPythonプログラミング
『ゼロから学ぶPythonプログラミング』の感想文こんにちは。現役エンジニアの”はやぶさ”@Cpp_Learningです。 今回は『ゼロから学ぶPythonプログラミング』という本...
Amazonギフト券チャージで最大2.5%ポイント還元
Amazonはチャージがお得

Amazonプライム会員なら、Amazonギフト券を現金でチャージ(コンビニ・銀行払い)すると最大2.5%ポイント還元!

クレジットカード払いでもキャンペーンエントリー0.5%ポイント還元中です。

Amazonでお得に買い物をするならまずはチャージから。

\チャージがお得/

詳細をチェックする

Amazonプライム無料体験中でもOK!

PICK UP BOOKS

  • 数理モデル入門
    数理モデル
  • Jetoson Nano 超入門
    Jetoson Nano
  • 図解速習DEEP LEARNING
    DEEP LEARNING
  • Pythonによる因果分析
    Python