agent-homebase/profiles/python-api.config.yml at main · benlaughlin/agent-homebase · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# python-api.config.yml
# Pre-filled for a Python API project (FastAPI / Flask / Django).
# Replace placeholder values (marked with FIXME) before running init.py.
# Note: bundle size checks in @perf are not applicable — set thresholds to 0.

editor:
  target: "both"                    # "vscode" | "claude-code" | "both"

project:
  name: "My Python API"            # FIXME
  language: "Python"
  framework: "FastAPI"             # FIXME: FastAPI | Flask | Django
  locale: "en-US"                  # FIXME if different
  namespace: "@org"                # Monorepo package namespace (e.g. @myorg) — used by @reviewer for import order rules

paths:
  sprints: "sprints/"
  sprints_doc: "SPRINTS.md"
  web_app_dir: "apps/web"         # Web app root directory — used by @a11y and @perf for build commands
  drafts: "docs/planning/drafts/"
  archive: "docs/archive/"
  validation: "docs/planning/validation/"
  research: "docs/planning/research/"
  handoffs: "docs/planning/_handoffs/"
  engagements: "docs/planning/engagements/"
  vision: "docs/planning/vision/"
  backlog_ledger: "docs/planning/BACKLOG_LEDGER.md"
  bug_backlog: "docs/planning/BUG_BACKLOG.md"
  bugs_screenshots: "docs/planning/bugs/screenshots/"
  rejections: "docs/planning/HANDOFF_REJECTIONS.md"
  non_goals: "docs/NON_GOALS.md"
  roadmap: "docs/planning/ROADMAP.md"
  feature_matrix: "docs/planning/FEATURE_MATRIX.md"
  decisions: "docs/architecture/DECISIONS.md"
  future_considerations: "docs/architecture/FUTURE_CONSIDERATIONS.md"
  design_reviews: "docs/architecture/design-reviews/"
  architecture_doc: "docs/architecture/ARCHITECTURE.md"
  technical_debt: "docs/development/TECHNICAL_DEBT.md"
  testing_doc: "docs/development/TESTING.md"
  user_guide: "docs/user/USER_GUIDE.md"
  releases: "docs/user/RELEASES.md"
  changelog: "docs/user/changelog.json"
  changelog_deploy_copy: "docs/user/changelog.json"   # No deploy copy needed for APIs
  package_json: "pyproject.toml"                      # Version lives here for Python projects
  # Security docs (owned by @security)
  security_changelog: "docs/security/SECURITY_CHANGELOG.md"
  file_hashes: "docs/security/FILE_HASHES.md"
  security_reports: "docs/security/reports/"
  sbom_output: "docs/security/sbom.json"
  copilot_instructions: ".github/copilot-instructions.md"
  instructions_dir: ".github/instructions"
  memory_architecture: ".claude/memory/architecture.md"
  memory_conventions: ".claude/memory/conventions.md"

quality:
  coverage_store_threshold: 80
  coverage_web_threshold: 70
  e2e_regression_threshold: 5
  bundle_warning_kb: 0             # Not applicable for Python — set to 0 to disable
  bundle_critical_kb: 0            # Not applicable for Python — set to 0 to disable
  build_warning_seconds: 120       # Docker builds take longer

platform:
  type: "none"                     # FIXME: none | github-pages | custom
  test_workflow: "ci.yml"          # FIXME
  prod_workflow: "deploy.yml"      # FIXME
  ci_workflow_display_name: "Python CI"  # FIXME
  test_url: "https://your-api-staging.example.com"  # FIXME
  prod_url: "https://your-api.example.com"          # FIXME
  e2e_runner: "pytest"

git:
  main_branch: "main"
  develop_branch: "develop"
  repo: "owner/your-repo"          # FIXME — GitHub repository for CI checks

ids:
  bug_prefix: "BUG"
  item_prefix: "ITEM"
  rejection_prefix: "REJ"
  engagement_prefix: "ENG"
  adr_prefix: "ADR"

escalation:
  def_p0_threshold: 3
  def_kill_threshold: 5
  age_stale_sprints: 10
  debt_warning_sprints: 3
  debt_escalate_sprints: 5
  debt_warning_items: 20
  debt_escalate_items: 40
  debt_min_allocation_percent: 30
  sprint_size_min: 5
  sprint_size_max: 8
  feature_cap_percent: 70
  p0_overflow_percent: 50

scope_upgrade:
  task_count: 3
  files_affected: 8

commands:
  install: "pip install -r requirements.txt"
  dev: "uvicorn main:app --reload"  # FIXME for your entrypoint
  test: "pytest"
  typecheck: "mypy ."
  lint: "ruff check ."
  build: "docker build -t app ."
  e2e: "pytest tests/e2e/"
  coverage: "pytest --cov=. --cov-report=term-missing"
  coverage_store: "pytest --cov=. --cov-report=term-missing"
  coverage_web: "pytest --cov=. --cov-report=term-missing"
  depcheck: "pip-audit"
  # Security gates (used by @security)
  sbom_generate: "cyclonedx-py -o sbom.json"
  sast: "bandit -r . -f json"
  secret_scan_history: "gitleaks detect --source . --verbose --report-format json"
  license_check: "pip-licenses --format=json"
  container_scan: "trivy image --format json"
  iac_scan: "checkov -d . --output json"
  timestamp: "date -u +\"%Y-%m-%dT%H:%M:%SZ\""

team:
  cto_name: "Your Name"            # FIXME

security:
  audit_on_sprint: true
  sbom_format: "cyclonedx"
  tracked_files: []
  sast_tool: "bandit"
  license_gate: false
  license_denylist: ["GPL-3.0-only", "AGPL-3.0-only", "SSPL-1.0"]
  license_allowlist: ["MIT", "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "ISC", "0BSD"]