作業時間を半減する環境構築：VSCode/タスクランナー｜“保存で整う・ワンキーで回る”仕組み化テンプレ

project_root/
  .vscode/
  src/
  tests/
  data/
  reports/
  README.md
  requirements.in
  Makefile
  pyproject.toml   # black/ruff/isort/pytest等の設定置き場
  .pre-commit-config.yaml

# Windows/Mac共通（PowerShell/Bash）
python -m venv .venv
. .venv/Scripts/activate # Windows PowerShell
# source .venv/bin/activate # macOS/Linux
python -m pip install --upgrade pip pip-tools


# 依存は requirements.in に記述
cat > requirements.in << 'EOF'
black
ruff
isort
pytest
pandas
matplotlib
EOF


# 依存関係を解決して固定化
pip-compile -o requirements.txt requirements.in
# .venv を requirements.txt と完全同期
pip-sync requirements.txt

{
  "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": { "source.organizeImports": true },
  "python.testing.pytestEnabled": true,
  "python.analysis.typeCheckingMode": "basic",
  "[python]": { "editor.defaultFormatter": "ms-python.black-formatter" },
  "ruff.lint.run": "onSave",
  "files.trimTrailingWhitespace": true,
  "files.insertFinalNewline": true
}

repos:
  - repo: https://github.com/psf/black
    rev: 24.4.2
    hooks: [{id: black}]
  - repo: https://github.com/charliermarsh/ruff-pre-commit
    rev: v0.5.0
    hooks: [{id: ruff}]
  - repo: https://github.com/pycqa/isort
    rev: 5.13.2
    hooks: [{id: isort}]
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
      - {id: end-of-file-fixer}
      - {id: trailing-whitespace}

pip install pre-commit
pre-commit install  # commit前に自動整形・静的解析

.PHONY: setup sync lint test format report run clean
PY?=.venv/bin/python
PIP?=.venv/bin/pip

setup:
$(PIP) install --upgrade pip pip-tools
pip-compile -o requirements.txt requirements.in
pip-sync requirements.txt

sync:
pip-sync requirements.txt

lint:
$(PY) -m ruff check src tests
$(PY) -m isort --check --diff src tests

format:
$(PY) -m isort src tests
$(PY) -m black src tests

test:
$(PY) -m pytest -q

report:
$(PY) -m src.report

run:
$(PY) -m src.main

clean:
rm -rf .pytest\_cache .ruff\_cache **pycache**

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Setup",
      "type": "shell",
      "command": "python -m pip install --upgrade pip pip-tools && pip-compile -o requirements.txt requirements.in && pip-sync requirements.txt"
    },
    {"label": "Lint", "type": "shell", "command": ".venv/bin/python -m ruff check src tests || .venv/Scripts/python -m ruff check src tests"},
    {"label": "Format", "type": "shell", "command": ".venv/bin/python -m isort src tests && .venv/bin/python -m black src tests || .venv/Scripts/python -m isort src tests && .venv/Scripts/python -m black src tests"},
    {"label": "Test", "type": "shell", "command": ".venv/bin/python -m pytest -q || .venv/Scripts/python -m pytest -q"},
    {"label": "All", "dependsOrder": "sequence", "dependsOn": ["Format", "Lint", "Test"]}
  ]
}

[
  {"key": "ctrl+shift+l", "command": "workbench.action.tasks.runTask", "args": "All"},
  {"key": "ctrl+shift+s", "command": "workbench.action.files.saveAll"}
]

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python: Run main",
      "type": "python",
      "request": "launch",
      "program": "${workspaceFolder}/src/main.py",
      "console": "integratedTerminal"
    },
    {
      "name": "Python: Pytest",
      "type": "python",
      "request": "launch",
      "module": "pytest",
      "args": ["-q"],
      "console": "integratedTerminal"
    }
  ]
}

[tool.black]
line-length = 100

\[tool.isort]
profile = "black"

\[tool.pytest.ini\_options]
minversion = "7.0"
addopts = "-q"

\[tool.ruff]
line-length = 100
select = \["E","F","I","B"]

# プロジェクト名
## 目的/KPI
- 例：定例レポートの自動生成（所要60→10分）
## 環境
- Python 3.11（.venv）／Windows 11 or macOS 14
## セットアップ
- `python -m pip install --upgrade pip pip-tools`
- `pip-compile -o requirements.txt requirements.in && pip-sync requirements.txt`
## 開発
- VSCodeで `Tasks: Run Task -> All`（Format→Lint→Test）
## 納品物
- `reports/weekly_report.pdf`、`README.md`、`CHANGELOG.md`