README で定義すべきこと
プロジェクト入口ドキュメントの構成要素と Python 自動収集 Tips

## インストール

### 1. リポジトリをクローン
```bash
git clone https://github.com/example/my-app.git
cd my-app
```

### 2. 依存パッケージのインストール
```bash
pip install -r requirements.txt
```

### 3. 環境変数の設定
```bash
cp .env.example .env
# .env を編集してください（次のセクションを参照）
```

### 4. データベースのマイグレーション
```bash
python manage.py migrate
```

### 5. 起動
```bash
python manage.py runserver
# → http://localhost:8000 でアクセス可能
```

## 環境変数

| 変数名 | 型 | デフォルト | 説明 |
|---|---|---|---|
| `DATABASE_URL` | string | — | PostgreSQL 接続文字列（必須） |
| `SECRET_KEY` | string | — | Django シークレットキー（必須） |
| `DEBUG` | bool | `false` | デバッグモード。本番では `false` にすること |
| `ALLOWED_HOSTS` | string | `localhost` | カンマ区切りで許可ホストを指定 |
| `CACHE_TTL` | int | `300` | Redis キャッシュ TTL（秒） |

## ディレクトリ構成

```
my-app/
├── src/          # アプリケーション本体
│   ├── api/      # REST API エンドポイント
│   ├── models/   # データモデル
│   └── utils/    # 共通ユーティリティ
├── tests/        # テストコード
├── docs/         # 設計書・ADR
├── scripts/      # 運用・開発補助スクリプト
├── .env.example  # 環境変数のテンプレート
└── requirements.txt
```

"""
requirements.txt を読み込んでバージョン表を生成する。
README の「動作要件」セクションに貼り付ける用途。
"""
import subprocess
import sys

def get_installed_versions(req_file: str = "requirements.txt") -> list[dict]:
    """pip show で各パッケージの実際のバージョンを取得する。"""
    with open(req_file, encoding="utf-8") as f:
        packages = [
            line.strip().split("==")[0].split(">=")[0].split("~=")[0]
            for line in f
            if line.strip() and not line.startswith("#")
        ]

    results = []
    for pkg in packages:
        try:
            out = subprocess.check_output(
                [sys.executable, "-m", "pip", "show", pkg],
                stderr=subprocess.DEVNULL,
                text=True
            )
            info = {}
            for line in out.splitlines():
                if ": " in line:
                    key, val = line.split(": ", 1)
                    info[key.strip()] = val.strip()
            results.append({
                "name":    info.get("Name", pkg),
                "version": info.get("Version", "不明"),
                "summary": info.get("Summary", ""),
            })
        except subprocess.CalledProcessError:
            results.append({"name": pkg, "version": "未インストール", "summary": ""})
    return results

def print_markdown_table(packages: list[dict]) -> None:
    print("| パッケージ | バージョン | 説明 |")
    print("|---|---|---|")
    for p in packages:
        print(f"| `{p['name']}` | {p['version']} | {p['summary']} |")

if __name__ == "__main__":
    pkgs = get_installed_versions()
    print_markdown_table(pkgs)

"""
プロジェクトのディレクトリ構成を README 用に出力する。
深さ・除外パターンを設定できる。
"""
import os
from pathlib import Path

EXCLUDE = {".git", "__pycache__", ".venv", "venv", "node_modules", ".pytest_cache"}
MAX_DEPTH = 3

def print_tree(path: Path, prefix: str = "", depth: int = 0) -> None:
    if depth > MAX_DEPTH:
        return
    entries = sorted(
        [e for e in path.iterdir() if e.name not in EXCLUDE],
        key=lambda e: (e.is_file(), e.name)
    )
    for i, entry in enumerate(entries):
        connector = "└── " if i == len(entries) - 1 else "├── "
        print(prefix + connector + entry.name + ("/" if entry.is_dir() else ""))
        if entry.is_dir():
            extension = "    " if i == len(entries) - 1 else "│   "
            print_tree(entry, prefix + extension, depth + 1)

if __name__ == "__main__":
    root = Path(".")
    print(f"```\n{root.resolve().name}/")
    print_tree(root)
    print("```")

"""
git log からプロジェクトのメタ情報を収集する。
README の「最終更新日」「主要コントリビュータ」欄の自動更新に使う。
"""
import subprocess
from collections import Counter
from datetime import datetime

def run_git(*args) -> str:
    result = subprocess.run(
        ["git", *args], capture_output=True, text=True, check=True
    )
    return result.stdout.strip()

def get_last_commit_date() -> str:
    """最新コミット日時（ISO 形式）を返す。"""
    iso = run_git("log", "-1", "--format=%cI")
    dt = datetime.fromisoformat(iso)
    return dt.strftime("%Y年%m月%d日")

def get_top_contributors(n: int = 5) -> list[tuple[str, int]]:
    """コミット数上位 n 名を返す。"""
    log = run_git("log", "--format=%aN")
    counter = Counter(log.splitlines())
    return counter.most_common(n)

def get_current_branch() -> str:
    return run_git("rev-parse", "--abbrev-ref", "HEAD")

def get_tag_list() -> list[str]:
    """最新5タグを返す（バージョン履歴に使う）。"""
    tags = run_git("tag", "--sort=-creatordate")
    return tags.splitlines()[:5]

if __name__ == "__main__":
    print(f"最終更新: {get_last_commit_date()}")
    print(f"現在のブランチ: {get_current_branch()}")
    print("\n## コントリビュータ（コミット数上位）")
    for name, count in get_top_contributors():
        print(f"- {name}: {count} commits")
    print("\n## 最新タグ")
    for tag in get_tag_list():
        print(f"- {tag}")