From d2451b0bee3f99141fd6bcbbd99df2dc56d14dd5 Mon Sep 17 00:00:00 2001 From: "shimoda.m@nds-tyo.co.jp" Date: Thu, 30 Mar 2023 18:09:02 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20README=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ecs/jskult-batch-daily/README.md | 73 ++++++++++++++++++++++++++++++++ ecs/jskult-webapp/README.md | 3 +- 2 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 ecs/jskult-batch-daily/README.md diff --git a/ecs/jskult-batch-daily/README.md b/ecs/jskult-batch-daily/README.md new file mode 100644 index 00000000..c0bfb248 --- /dev/null +++ b/ecs/jskult-batch-daily/README.md @@ -0,0 +1,73 @@ +# 実消化&アルトマーク 日次バッチ + +## 概要 + +実消化&アルトマークの日次バッチ処理。 + +## 環境情報 + +- Python 3.9 +- MySQL 8.x +- VSCode + +## 環境構築 + +- Pythonの構築 + - Merck_NewDWH開発2021のWiki、[Python環境構築](https://nds-tyo.backlog.com/alias/wiki/1874930)を参照 + - 「Pipenvの導入」までを行っておくこと + - 構築完了後、プロジェクト配下で以下のコマンドを実行し、Pythonの仮想環境を作成する + - `pipenv install --python ` + - この手順で出力される仮想環境のパスは、後述するVSCodeの設定手順で使用するため、控えておく + +- MySQLの環境構築 + - Windowsの場合、以下のリンクからダウンロードする + - + - Dockerを利用する場合、「newsdwh-tools」リポジトリのMySQL設定を使用すると便利 + - 「crm-table-to-ddl」フォルダ内で以下のコマンドを実行すると + - `docker-compose up -d` + - Dockerの構築手順は、[Dockerのセットアップ手順](https://nds-tyo.backlog.com/alias/wiki/1754332)を参照のこと + - データを投入する + - 立ち上げたデータベースに「src05」スキーマを作成する + - [ローカル開発用データ](https://ndstokyo.sharepoint.com/:f:/r/sites/merck-new-dwh-team/Shared%20Documents/03.NewDWH%E6%A7%8B%E7%AF%89%E3%83%95%E3%82%A7%E3%83%BC%E3%82%BA3/02.%E9%96%8B%E7%99%BA/90.%E9%96%8B%E7%99%BA%E5%85%B1%E6%9C%89/%E3%83%AD%E3%83%BC%E3%82%AB%E3%83%AB%E9%96%8B%E7%99%BA%E7%94%A8%E3%83%87%E3%83%BC%E3%82%BF?csf=1&web=1&e=VVcRUs)をダウンロードし、mysqlコマンドを使用して復元する + - `mysql -h <ホスト名> -P <ポート> -u <ユーザー名> -p src05 < src05_dump.sql` +- 環境変数の設定 + - 「.env.example」ファイルをコピーし、「.env」ファイルを作成する + - 環境変数を設定する。設定内容はPRJメンバーより共有を受けてください +- VSCodeの設定 + - 「.vscode/recommended_settings.json」ファイルをコピーし、「settings.json」ファイルを作成する + - 「python.defaultInterpreterPath」を、Pythonの構築手順で作成した仮想環境のパスに変更する + +## 実行 + +- VSCode上で「F5」キーを押下すると、バッチ処理が起動する。 +- 「entrypoint.py」が、バッチ処理のエントリーポイント。 +- 実際の処理は、「src/jobctrl_daily.py」で行っている。 + +## フォルダ構成 + +```text +. +├── Pipfile -- Pythonモジュールの依存関係を管理するファイル +├── Dockerfile -- Dockerイメージを作成するためのファイル +├── Pipfile -- Pythonモジュールの依存関係を管理するファイル +├── Pipfile.lock -- Pythonモジュールの依存関係バージョン固定用ファイル +├── README.md -- 当ファイル +├── entrypoint.py -- バッチ処理のエントリーポイントになるpythonファイル +└── src -- ソースコードの保管場所 + ├── batch -- バッチ処理関連ソース置き場 + │ ├── batch_functions.py -- バッチ処理共通関数置き場 + │ ├── datachange -- 実績洗替関連ソース置き場 + │ │ └── emp_chg_inst_lau.py -- 施設担当者マスタ洗替 + │ └── jissekiaraigae.py -- 実績洗替処理のエントリーポイント + ├── db + │ └── database.py -- データベース操作共通処理 + ├── error + │ └── exceptions.py -- カスタム例外 + ├── jobctrl_daily.py -- 日次バッチ処理のエントリーポイント。「entrypoint.py」 から呼ばれる。 + ├── logging + │ └── get_logger.py -- ログ出力の共通処理 + ├── system_var + │ └── environment.py -- 環境変数 + └── time + └── elapsed_time.py -- 実行時間計測用 +``` diff --git a/ecs/jskult-webapp/README.md b/ecs/jskult-webapp/README.md index 91fc0ca4..783f82a2 100644 --- a/ecs/jskult-webapp/README.md +++ b/ecs/jskult-webapp/README.md @@ -53,9 +53,10 @@ ```text . +├── Dockerfile -- Dockerイメージを作成するためのファイル ├── Pipfile -- Pythonモジュールの依存関係を管理するファイル ├── Pipfile.lock -- Pythonモジュールの依存関係バージョン固定用ファイル -├── README.md +├── README.md -- 当ファイル └── src -- ソースコードの保管場所 ├── aws -- AWSリソース操作用のコード │   ├── aws_api_client.py