プログラムの可読性と保守性を向上させるために、ソフトウェアの適切なディレクトリ構造を設計する必要があります。これは、標準のコーディング スタイルと同じくらい重要です。あなたのソフトウェアがQQと呼ばれていると仮定すると、それが明確で読みやすい限り、ソフトウェアのディレクトリ仕様に厳密な基準はありません。推奨されるディレクトリ構造は次のとおりです。
QQ/
|-- core/
| |-- core.py
|
|-- api/
| |-- api.py
|
|-- db/
| |-- db_handle.py
|
|-- lib/
| |-- common.py
|
|-- conf/
| |-- settings.py
|
|-- run.py
|-- setup.py
|-- requirements.txt
|-- README説明をしましょう：
• core/ : ビジネス ロジック関連のコードを格納します。
• api/ : インターフェイス ファイルを格納します。このインターフェイスは、主にビジネス ロジックのデータ操作を提供するために使用されます。
• db/ : 操作データベースに関連するファイルを格納します。主にデータベースとの対話に使用されます。
• lib/ : プログラムで一般的に使用されるカスタム モジュールを保存します。
• conf/ : 設定ファイルを保存します
• run.py : 通常、プロジェクトのルート ディレクトリに配置されるプログラムのスタートアップ ファイル。環境変数を扱う必要がなくなります
• setup.py : インストール、展開、およびパッケージ化のためのスクリプト。
• requirements.txt : ソフトウェアが依存する外部 Python パッケージのリストを保存します。
• README : プロジェクトのドキュメント。
README の形式は、一般的に次のとおりです。
1.ソフトウェアの位置付けとソフトウェアの基本機能。
2. コードの実行方法: インストール環境、起動コマンドなど。
3. 簡単な使用説明書;
4.コードディレクトリ構造の説明、より詳細なポイントは、ソフトウェアの基本原則を説明できます。
5. よくある質問の説明。
一般に、setup.pyを使用して、コードのパッケージ化、インストール、および展開の問題を管理します。The industry standard way of writing is to use the popular Python packages tool setuptools to manage these things. この方法は、オープン ソース プロジェクトで広く使用されています. プロジェクトには、環境を迅速かつ簡単にインストールできるインストールおよび展開ツールが必要です.新しいマシン コードが展開され、プログラムが実行されます。
requirements.txtファイルは、開発者がソフトウェアの依存関係を維持しやすくするために存在します。setup.py に依存関係をインストールするときに、ソフトウェア パッケージの欠落を避けるために、開発プロセスで依存ライブラリの情報をこのファイルに追加する必要があります。また、ユーザーがプロジェクトによって参照される Python パッケージを指定することも便利です。このファイルの形式は、各行にパッケージの依存関係の説明が含まれており、通常はフラスコ>=0.10 の形式です. 要件は、この形式が pip によって認識され、pip install-rの要件を簡単に渡すことができることです. TXT