docs: ローカル開発環境の構築や実行方法について、READMEに追記し、周辺のファイルも一緒に追加
This commit is contained in:
parent
c6f15e22b9
commit
a53e60cbf1
5
.gitignore
vendored
5
.gitignore
vendored
@ -1,4 +1,7 @@
|
||||
lambda/mbj-newdwh2021-staging-NoticeToSlack/package-lock.json
|
||||
lambda/mbj-newdwh2021-staging-NoticeToSlack/node_modules/*
|
||||
lambda/mbj-newdwh2021-staging-PublishFromLog/package-lock.json
|
||||
lambda/mbj-newdwh2021-staging-PublishFromLog/node_modules/*
|
||||
lambda/mbj-newdwh2021-staging-PublishFromLog/node_modules/*
|
||||
|
||||
**/.vscode/settings.json
|
||||
.env
|
||||
20
ecs/crm-datafetch/.vscode/recommend_settings.json
vendored
Normal file
20
ecs/crm-datafetch/.vscode/recommend_settings.json
vendored
Normal file
@ -0,0 +1,20 @@
|
||||
{
|
||||
"[python]": {
|
||||
"editor.defaultFormatter": null,
|
||||
"editor.formatOnSave": true,
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.organizeImports": true
|
||||
}
|
||||
},
|
||||
"python.linting.lintOnSave": true,
|
||||
"python.linting.enabled": true,
|
||||
"python.linting.pylintEnabled": false,
|
||||
"python.linting.flake8Enabled": true,
|
||||
"python.linting.flake8Args": ["--max-line-length=120"],
|
||||
"python.formatting.provider": "autopep8",
|
||||
"python.formatting.autopep8Args": [
|
||||
"--max-line-length",
|
||||
"120"
|
||||
]
|
||||
}
|
||||
|
||||
69
ecs/crm-datafetch/README.md
Normal file
69
ecs/crm-datafetch/README.md
Normal file
@ -0,0 +1,69 @@
|
||||
# CRMデータ連携 データ取得処理 ECSタスク
|
||||
|
||||
## 前提事項
|
||||
|
||||
### ツールのバージョン
|
||||
|
||||
- Python 3.8.x
|
||||
- PipEnv(Pythonの依存関係管理用モジュール)
|
||||
|
||||
### 開発環境
|
||||
|
||||
- Visual Studio Code
|
||||
|
||||
## 開発環境構築
|
||||
|
||||
※下記の操作は基本的にVSCode上で行います。
|
||||
|
||||
- [ファイル]-[フォルダーを開く]から、当フォルダを選択して開く
|
||||
|
||||
- [Wiki | Pythonの環境構築](https://nds-tyo.backlog.com/alias/wiki/1874930)にて、pyenvの導入まで完了させる
|
||||
- **pyenvの導入はマストではないが、Pythonのバージョンが前提のバージョンと同一であることを確認して開発を進めてください**
|
||||
- **確認しながら開発するのは煩わしいため、導入を強く推奨します。**
|
||||
|
||||
- ローカルのPythonでPipEnvをインストールする
|
||||
|
||||
```sh
|
||||
pip install pipenv
|
||||
```
|
||||
|
||||
- pipenvの仮想環境と依存パッケージをインストール。このとき、初回実行にはpythonの仮想環境のパスがターミナルに表示されるため、控えておく
|
||||
|
||||
```sh
|
||||
# 開発用パッケージも含めてインストール
|
||||
pipenv install --dev
|
||||
```
|
||||
|
||||
- VSCodeのコマンドパレットを[表示]-[コマンドパレット]から開き、`Python: Select interpreter`を選択して実行する
|
||||
- Pythonの実行環境を聞かれるため、先に控えたパスと一致するものを選択する
|
||||
- 出てこない場合、一度VSCodeを閉じて再度開き直す
|
||||
|
||||
- 当フォルダ直下の`.vscode`フォルダ内にある`recommend_settings.json`をコピーし、同フォルダ内に`settings.json`を作成する
|
||||
|
||||
## ローカルでの起動方法
|
||||
|
||||
- 当フォルダ直下の`.vscode`フォルダ内に`launch.json`を作成する
|
||||
- 以下のJSONを入力して保存する
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "Python: Current File",
|
||||
"type": "python",
|
||||
"request": "launch",
|
||||
// エントリーポイントのファイルに変更すること
|
||||
"program": "<エントリーポイントになるファイル>",
|
||||
"console": "integratedTerminal",
|
||||
"justMyCode": true,
|
||||
// 環境変数が必要な場合に読み込む環境変数ファイル
|
||||
"envFile": "${workspaceFolder}/.env",
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- 環境変数が必要な場合、直接設定するか、上記JSONの`"envFile"`に設定されたパスに`.env`ファイルを作成し、環境変数を入力する
|
||||
- キーボードの「F5」キーを押して起動する
|
||||
- デバッグモードで実行されるため、適当なところにブレークポイントを置いてデバッグすることができる
|
||||
Loading…
x
Reference in New Issue
Block a user