標準化プログラム構造のよりよい制御、アプリケーションを読みやすくします。
プロジェクトのディレクトリ構造は、カテゴリの可読性と保守性「実際に属している」、「我々は明確な階層ディレクトリ構造を設計し、それは以下の2点を達成することです。
高い可読性:このプロジェクトの人々のためのコードに慣れていない、1はその上のテストディレクトリ、設定ファイル、および起動スクリプトを、知られているディレクトリ構造を理解することができます。だから、非常に速く、このプロジェクトについて。
高い保守性:良い組織のルールの定義、守備は非常に明確に任意のディレクトリの下に配置する必要があり、新たなどのファイルとコードを知ることができるようになります。利点は、時間の経過とともに、コード/構成サイズが増加すると、プロジェクトの構造はまだ、よく整理することが混同されない、ということです。
だから、必要な明確なレベルのディレクトリ構造を維持します。
良いPythonプロジェクトのディレクトリ構造を整理する方法について、既にいくつかのコンセンサスは、ディレクトリ構造があったされています。
プロジェクト名がfoo、このような最も便利なディレクトリ構造であると仮定すると:
FOO / | - binに/ | | - FOO | | - FOO / | | -テスト/ | | | -を__init__.py | | | - test_main.py | | | | -を__init__.py | | -をmain.py | | --conf / | | -を__init__.py | | -のsettings.py | | --logs / | | -ドキュメント/ | | - conf.py | | - abc.rst | | -のsetup.py | - requirements.txt | - README
簡単な説明:
bin/
:実行可能ファイルに保存されているいくつかのアイテムfoo/
:すべてのプロジェクトのソースコードを保存してください。(1)すべてのソースコード・モジュール、パッケージは、このディレクトリに置かれるべきです。最上位のディレクトリを入れないでください。
(2)そのサブ
tests/
ストレージユニットテストコード。入口(3)プログラムは、好ましくは、命名され
main.py
。conf/
:設定ファイルに保存されているいくつかのアイテム。logs/
:ログ情報は、プロジェクトの実施に格納されます。docs/
:いくつかの書類を保管してください。setup.py
:インストール、展開、スクリプトパッケージ。requirements.txt
:Pythonパッケージは、外部ソフトウェア依存関係のリストを格納します。README
:プロジェクトのドキュメント。
README書き込み要件:
これは、以下の事項ことに留意すべきです。
ソフトウェアのローカリゼーション、ソフトウェアの基本的な機能。
設置環境、スタートコマンド:コードを実行する方法。
使用の簡単な説明。
コードのディレクトリ構造は、より詳細な説明は、ソフトウェアの基本的な原則を指すことができます。
よくある質問。
開発プロセスが明確か月の変化を超えていないため、ソフトウェア開発の初期には、必ずしもすべての情報は、冒頭に補完されます。しかし、プロジェクトの終わりに、そのような文書を記述する必要があります。