GitをPythonのプロジェクトで使うにはgitignoreはどうする?

アフィリエイト広告を利用しています

このページの内容が役に立ったら X (旧twitter) でフォローして頂けると励みになります
挨拶や報告は無しで大丈夫です

このページでやりたいこと

  • PythonのプロジェクトをGit管理したい
  • Gitに含めるべきファイルを知りたい
  • Gitに含めるべきでないファイルを知りたい

自動生成される系は基本的に含めない

実行ファイル(EXE)にしたり、書き出し機能を持ったアプリから生成したファイルなどは基本的に Gitに含めません。

例えば build, dist フォルダが含まれます。
これらは .gitignore に登録しておきます。

/build
/dist

最初は、自動生成されたファイルであっても、そこに自分の手が加わって編集することがあれば、それはGit管理としたほうが良いです。

venv(仮想環境)をどうするか

venvフォルダはプロジェクト単位で作成する方針としています。
プロジェクトフォルダの下に venv フォルダがある形です。

となると、venv をGit に入れるか問題が出てきますね。
結論としては、venv は gitignore です。

.gitignore に次のパスを加えておきます。

/venv

pip でインストールしたもの

pipでインストールしたものはテキストファイルに書き出して Git に登録します。
具体的には次のコマンドでカレントディレクトリに requirements.txt を作成し、このファイルをGitに登録します。

pip freeze > requirements.txt

pip を復元するには

他のメンバーなどが増えたとき、 requirements.txt の内容で環境を復元するには次のようにします。

pip install -r requirements.txt