この記事ではFlaskプロジェクトのディレクトリ構成について解説します。Flaskアプリケーションは単一ファイルにまで単純化することが可能ですが、実用的なアプリケーションでは複数のモジュールからなるパッケージを構成するのが一般的です。
Flaskプロジェクトは次のようなフォルダ構成を取るのが望ましいです。
出典:Flask公式ドキュメント(https://msiz07-flask-docs-ja.readthedocs.io/ja/latest/index.html)
- flaskr/、アプリケーションのコードとファイルを含んだPythonのpackage
- tests/、テスト用moduleを含んだディレクトリ
- venv/、Flaskとその他の依存対象がインストールされたPythonの仮想環境
- インストール関連のファイル(図ではsetup.pyとMANIFEST.in)。projectをどのようにインストールするかをPythonへ伝えます。
- 将来自分で追加するかもしれない、その他のファイル
なお、Gitなどのバージョン管理ソフトを使用している場合、プロジェクトを実行している間に生成される以下のファイルはバージョン管理ソフトから無視されるべきです。
一般的に、自分で書かないファイルは無視します。