docs: READMEにファイル/フォルダ構成を追加

This commit is contained in:
shimoda.m@nds-tyo.co.jp 2022-08-03 11:50:08 +09:00
parent be8823d07f
commit 5a1012c4e0

View File

@ -68,6 +68,49 @@
- キーボードの「F5」キーを押して起動する
- デバッグモードで実行されるため、適当なところにブレークポイントを置いてデバッグすることができる
## ファイル/フォルダ構成
`[〇〇処理モジュール]`と記載されているファイルは、設計書に記載のシートと一致したPythonファイルです
```text
.
├── Dockerfile -- Dokcerイメージを作成するためのファイル
├── Pipfile -- Pipenv(Pythonの仮想環境管理モジュール)で、依存関係を管理するためのファイル
├── Pipfile.lock -- Pipenvでインストールされた依存関係のバージョン固定ファイル
├── README.md -- README
├── main.py -- CRMデータ取得処理のエントリーポイント
├── src/ -- プロダクトコード置き場
│ ├── aws/ -- AWSのリソース操作関連のモジュール置き場
│ ├── backup_crm_csv_data_process.py -- [CSVバックアップ処理]モジュール
│ ├── backup_crm_data_process.py -- [CRM電文データバックアップ処理]モジュール
│ ├── check_object_info_process.py -- [オブジェクト情報形式チェック処理]モジュール
│ ├── config/ -- 設定ファイル関連のモジュール置き場
│ ├── controller.py -- [コントロール処理]モジュール
│ ├── convert_crm_csv_data_process.py -- [CSV変換処理]モジュール
│ ├── converter/ -- CSV変換処理で実際に変換を行うモジュール置き場
│ ├── copy_crm_csv_data_process.py -- [CSVアップロード処理]モジュール
│ ├── error/ -- 処理エラー発生時カスタム例外モジュール置き場
│ ├── fetch_crm_data_process.py -- [CRMデータ取得処理]モジュール
│ ├── parser/ -- [JSON変換処理]モジュール置き場
│ ├── prepare_data_fetch_process.py -- データ取得準備処理
│ ├── salesforce/ -- SalesforceのAPIリクエストモジュール置き場
│ ├── set_datetime_period_process.py -- [データ取得期間設定処理]モジュール
│ ├── system_var/ -- 環境変数と定数ファイル置き場
│ ├── upload_last_fetch_datetime_process.py -- [前回取得日時ファイル更新処理]モジュール
│ ├── upload_result_data_process.py -- [取得処理実施結果アップロード処理]モジュール
│ └── util/ -- ユーティリティモジュール置き場
│ ├── counter_object.py -- リトライ判定のためのカウントアップクラス
│ ├── dict_checker.py -- 辞書型値オブジェクトの設定値チェック用クラス
│ ├── execute_datetime.py -- 取得処理開始年月日時分秒の管理クラス
│ └── logger.py -- ログ管理クラス
└── tests/ -- テストコード置き場
├── aws -- AWS操作モジュールのテスト
├── ... -- src配下のモジュール構成と同じ階層にテストコードを追加していく
├── conftest.py -- pytestのフィクスチャやフックを管理するファイル
└── docstring_parser.py -- pytest-htmlのレポート出力用のヘルパー
```
## 単体テストについて
### 前提