まず、なぜの構造を標準化する必要があります
自分自身のためにそれを読んで、読むために他の人のための標準化された均一のためのコース構造の。
第二に、標準化されたディレクトリ組織
一般的にはすべてこの方法は、(Roygoodのブログは、図から取られます)。
1. FOOは、私たちのプロジェクトの名前です。
2.ビン:実行可能ファイルやスクリプトに保存されている以下の項目
3.db(略称データベース):いくつかのデータを保存するために使用
4.ドキュメント:一般にも名前のログ、ストアログファイルに使用するには、主に背後に実行されているプロジェクトをデバッグするために使用します
5. setup.py:インストール、展開、パッケージ化されたスクリプト
6. requirements.txt:必要なパッケージの外部に格納されているファイルのリスト
7.README:項目説明ファイル(名の形式は、マークダウンエディタで、た.md)
READMEの内容に関しては第三に、
主に以下の説明のための最も一般的なgithhubプロジェクト、:
1.ソフトウェアの機能
2.ソフトウェアの動作環境と同様に、起動方法
使用3.簡単な説明。
4.コードのディレクトリ構造、より精巧なソフトウェアは、基本的な原理を説明することができます。
問題の一般的な説明。
四、setup.pyファイルアクション
一般に、使用することはsetup.py
、コード、インストールと展開の問題を管理するために梱包します。業界標準は、Pythonの人気のパッケージツールの中に書かれているsetuptoolsのこれらの事を管理すること。このモードは、一般的に、オープンソースプロジェクトを使用しています。しかし、ここではこれらの問題を解決するために標準化されたツールを使用していないの核となるアイデアだが、と言ったプロジェクトをインストールするには、展開ツールを持っている必要があり、迅速かつ容易に、コードをデプロイして実行される環境に新しいマシンにインストールすることができます。アップ。setup.py
これらのことは、一緒に自動化された効率を改善し、エラーの確率を低減することができます。「自動化された複雑な事は、物事は自動化されなければならない自動化することができます。」非常に良い習慣です。
五、requirements.txtファイル
現在のドキュメントの目的へ:
- 方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中,避免在
setup.py
安装依赖时漏掉软件包。 - 方便读者明确项目使用了哪些Python包。
这个文件的格式是每一行包含一个包依赖的说明,通常是flask>=0.10
这种格式,要求是这个格式能被pip
识别,这样就可以简单的通过 pip install -r requirements.txt
来把所有Python包依赖都装好了。