はじめに

環境構築ってめんどくさいですよね。
はい、ということでテンプレ作りました。
完成品はこちらになります。

全体像の説明

DevContainerと呼ばれるVSCodeの機能をベースに

などを導入した環境です。

テンプレを使うとこのような感じですぐに開発を始めることができます。

git clone https://github.com/YutaEiki-BP/python-template.git [フォルダ名]

フォルダ名を適宜置き換えて上記のコマンドを実行すると、テンプレを含んだフォルダができます。
このままだとテンプレのgitが残っているので一旦以下のコマンドで削除します。

cd [フォルダ名]
rm -rf .git

gitを使いたい場合は上記のコマンドに続けて以下のコマンドを実行してください。

git init

先ほど作成したフォルダをVSCodeで開きます。
すると画像のように「コンテナで再度開く」と表示されるのでクリックしてください。

しばらく待って左下が開発コンテナーとなったら起動成功です！

各ツールの詳細な説明はいずれ別記事で書きたいと思います。
ここでは簡単な説明だけ行います。

Pythonライブラリの管理にはpoetryを使用しています。
ライブラリを追加したい場合はCmd + Shift + ` (Windowsの場合はCtrl + Shift + `)でターミナルを開き

poetry add [ライブラリ名]

とすることでライブラリを追加することができます。

コミットの際にはpre-commitによる自動チェックが行われます。
これによってリポジトリ全体の品質を保ちます。

などが行われますが、このほかにもチェックを追加することが可能です。

テスト用ツールとしてpytestを導入しています。
設定済みのためすぐにテストを開始することができます。

今回はPython環境のテンプレを作った話でした。
短い経験ではありますが役に立ったプラクティスを盛り込んでますのでぜひ一度お試しください。
この記事では触れていませんが環境構築の思考プロセスなど追々話していければなと思います。
また、需要があればカスタマイズの方法なども今後記事化するつもりです。

お問い合わせについてはyuta.eiki@brainpad.co.jpまでお願いします。