From 48cb17e8fe245452e5408f58d7d1ecd54afcdca0 Mon Sep 17 00:00:00 2001
From: "shimoda.m@nds-tyo.co.jp" <shimoda.m@nds-tyo.co.jp>
Date: Fri, 8 Jul 2022 13:03:48 +0900
Subject: [PATCH] =?UTF-8?q?docs:=20README=E3=82=92=E8=BF=BD=E5=8A=A0?=
 =?UTF-8?q?=E3=80=82=E4=B8=BB=E3=81=AB=E7=92=B0=E5=A2=83=E6=A7=8B=E7=AF=89?=
 =?UTF-8?q?=E3=81=AB=E9=96=A2=E3=81=99=E3=82=8B=E3=81=93=E3=81=A8=E3=82=92?=
 =?UTF-8?q?=E8=A8=98=E8=BC=89=E3=81=97=E3=81=9F?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 ecs/dataimport/README.md | 48 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 ecs/dataimport/README.md

diff --git a/ecs/dataimport/README.md b/ecs/dataimport/README.md
new file mode 100644
index 00000000..8502b98e
--- /dev/null
+++ b/ecs/dataimport/README.md
@@ -0,0 +1,48 @@
+# データ取り込み処理
+
+## 概要
+
+データ取り込みバケット(`mbj-newdwh2021-<環境名>-data`)に配置されたデータファイルを、設定に基づいてデータベースに登録する処理を行う
+処理順序等の詳細は設計書を参照のこと
+
+## 環境構築
+
+### 事前準備
+
+- [Wiki - Python環境構築](https://nds-tyo.backlog.com/alias/wiki/1874930)の「pipenvの導入」まで完了していること
+
+### Python仮想環境にパッケージをインストール
+
+- このドキュメントと同じ階層でコマンドラインを開き、以下のコマンドを実行する
+
+  ```sh
+  pipenv install -r requirements.txt
+  ```
+
+- 以降、依存モジュールの追加が発生した場合に、`requirements.txt`に追記した上で、上記のコマンドを実行すること
+
+## ローカルでの実行手順
+
+- 当ディレクトリ内に`.vscode/launch.json`を作成し、以下のコードを貼り付ける
+  - 既にある場合は作成不要
+
+  ```json
+  {
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "name": "Python: データ取り込み処理",
+        "type": "python",
+        "request": "launch",
+        "program": "ecs/dataimport/controller.py",
+        "console": "integratedTerminal",
+        "justMyCode": true,
+        "envFile": "${workspaceFolder}/.env",
+      }
+    ]
+  }
+  ```
+
+- 当ディレクトリ内に`.env`ファイルを、作成し、環境変数を設定する
+  - 設定する環境変数は設計書を参照のこと
+- F5キーを押し、処理を実行する