Pythonプロジェクトのモジュールとフォルダ構成は、プロジェクトの目的や規模により異なる場合がありますが、一般的な構成を以下に示します。
基本的なディレクトリ構成
プロジェクト名/
│ ├─ __init__.py
│ ├─ main.py （メインの実行ファイル）
この構成では、__init__.pyはPythonにパッケージとして認識させるためのファイルで、パッケージをインポートしたときに実行されます。main.pyはアプリケーションのメインの実行ファイルです。
プロジェクトの詳細な構成
より詳細なプロジェクトの構成を以下に示します。
myproject(root) /
├─ myproject /
│ ├─ __init__.py
│ ├─ __main__.py
│ ├─ cli.py
│ ├─ mylib /
│ ├─ __init__.py
│ ├─ mylib.py
│
├─ docs /
│ ├─ conf.py
│ ├─ index.rst
│
├─ tests /
│ ├─ test_basic.py
│ ├─ test_advanced.py
│
├─ README.md (or README.rst)
├─ requirements.txt
├─ setup.py
└─ LICENSE
この構成では、myprojectディレクトリは開発するプロジェクトの名称で、任意の名称を付けることができます。docsディレクトリはドキュメントの保管フォルダで、testsディレクトリはテストコードの保管フォルダです。
まとめ
Pythonプロジェクトのモジュールとフォルダ構成は、プロジェクトの目的や規模により異なる場合があります。しかし、上記の構成は一般的なPythonプロジェクトでよく見られるものです。適切な構造はプロジェクトに応じるため、一例として参考にしてみてください。