@hivehub/rulebook 4.2.2 → 4.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (334) hide show
  1. package/.claude/commands/continue.md +33 -33
  2. package/.claude/commands/ralph-config.md +112 -112
  3. package/.claude/commands/ralph-history.md +110 -110
  4. package/.claude/commands/ralph-init.md +72 -72
  5. package/.claude/commands/ralph-pause-resume.md +105 -105
  6. package/.claude/commands/ralph-run.md +101 -101
  7. package/.claude/commands/ralph-status.md +76 -76
  8. package/.claude/commands/rulebook-memory-save.md +48 -48
  9. package/.claude/commands/rulebook-memory-search.md +47 -47
  10. package/.claude/commands/rulebook-task-apply.md +67 -67
  11. package/.claude/commands/rulebook-task-archive.md +70 -70
  12. package/.claude/commands/rulebook-task-create.md +93 -93
  13. package/.claude/commands/rulebook-task-list.md +42 -42
  14. package/.claude/commands/rulebook-task-show.md +52 -52
  15. package/.claude/commands/rulebook-task-validate.md +53 -53
  16. package/.claude-plugin/marketplace.json +28 -28
  17. package/.claude-plugin/plugin.json +8 -8
  18. package/README.md +8 -1
  19. package/dist/cli/commands.d.ts.map +1 -1
  20. package/dist/cli/commands.js +4 -4
  21. package/dist/cli/commands.js.map +1 -1
  22. package/dist/core/claude-mcp.d.ts +8 -1
  23. package/dist/core/claude-mcp.d.ts.map +1 -1
  24. package/dist/core/claude-mcp.js +32 -1
  25. package/dist/core/claude-mcp.js.map +1 -1
  26. package/dist/core/generator.d.ts +13 -0
  27. package/dist/core/generator.d.ts.map +1 -1
  28. package/dist/core/generator.js +283 -28
  29. package/dist/core/generator.js.map +1 -1
  30. package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
  31. package/dist/core/workspace/workspace-manager.js +2 -6
  32. package/dist/core/workspace/workspace-manager.js.map +1 -1
  33. package/dist/index.js +1 -3
  34. package/dist/index.js.map +1 -1
  35. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  36. package/dist/mcp/rulebook-server.js +5 -4
  37. package/dist/mcp/rulebook-server.js.map +1 -1
  38. package/package.json +21 -22
  39. package/templates/agents/accessibility-reviewer.md +43 -0
  40. package/templates/agents/api-designer.md +42 -0
  41. package/templates/agents/architect.md +51 -0
  42. package/templates/agents/build-engineer.md +36 -0
  43. package/templates/agents/code-reviewer.md +47 -0
  44. package/templates/agents/database-architect.md +41 -0
  45. package/templates/agents/devops-engineer.md +42 -0
  46. package/templates/agents/docs-writer.md +38 -0
  47. package/templates/agents/i18n-engineer.md +42 -0
  48. package/templates/agents/implementer.md +38 -35
  49. package/templates/agents/migration-engineer.md +42 -0
  50. package/templates/agents/performance-engineer.md +49 -0
  51. package/templates/agents/refactoring-agent.md +41 -0
  52. package/templates/agents/researcher.md +38 -34
  53. package/templates/agents/security-reviewer.md +40 -0
  54. package/templates/agents/team-lead.md +37 -34
  55. package/templates/agents/tester.md +45 -42
  56. package/templates/agents/ux-reviewer.md +43 -0
  57. package/templates/ci/rulebook-review.yml +26 -26
  58. package/templates/cli/AIDER.md +49 -49
  59. package/templates/cli/AMAZON_Q.md +25 -25
  60. package/templates/cli/AUGGIE.md +32 -32
  61. package/templates/cli/CLAUDE.md +117 -117
  62. package/templates/cli/CLINE.md +99 -99
  63. package/templates/cli/CODEBUDDY.md +20 -20
  64. package/templates/cli/CODEIUM.md +20 -20
  65. package/templates/cli/CODEX.md +21 -21
  66. package/templates/cli/CONTINUE.md +34 -34
  67. package/templates/cli/CURSOR_CLI.md +62 -62
  68. package/templates/cli/FACTORY.md +18 -18
  69. package/templates/cli/GEMINI.md +35 -35
  70. package/templates/cli/KILOCODE.md +18 -18
  71. package/templates/cli/OPENCODE.md +18 -18
  72. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  73. package/templates/commands/rulebook-memory-save.md +48 -48
  74. package/templates/commands/rulebook-memory-search.md +47 -47
  75. package/templates/commands/rulebook-task-apply.md +67 -67
  76. package/templates/commands/rulebook-task-archive.md +94 -94
  77. package/templates/commands/rulebook-task-create.md +93 -93
  78. package/templates/commands/rulebook-task-list.md +42 -42
  79. package/templates/commands/rulebook-task-show.md +52 -52
  80. package/templates/commands/rulebook-task-validate.md +53 -53
  81. package/templates/core/AGENTS_LEAN.md +25 -25
  82. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  83. package/templates/core/AGENT_AUTOMATION.md +288 -288
  84. package/templates/core/DAG.md +304 -304
  85. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  86. package/templates/core/MULTI_AGENT.md +74 -74
  87. package/templates/core/PLANS.md +28 -28
  88. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  89. package/templates/core/RALPH.md +471 -471
  90. package/templates/core/RULEBOOK.md +1935 -1935
  91. package/templates/frameworks/ANGULAR.md +36 -36
  92. package/templates/frameworks/DJANGO.md +83 -83
  93. package/templates/frameworks/ELECTRON.md +147 -147
  94. package/templates/frameworks/FLASK.md +38 -38
  95. package/templates/frameworks/FLUTTER.md +55 -55
  96. package/templates/frameworks/JQUERY.md +32 -32
  97. package/templates/frameworks/LARAVEL.md +38 -38
  98. package/templates/frameworks/NESTJS.md +43 -43
  99. package/templates/frameworks/NEXTJS.md +127 -127
  100. package/templates/frameworks/NUXT.md +40 -40
  101. package/templates/frameworks/RAILS.md +66 -66
  102. package/templates/frameworks/REACT.md +38 -38
  103. package/templates/frameworks/REACT_NATIVE.md +47 -47
  104. package/templates/frameworks/SPRING.md +39 -39
  105. package/templates/frameworks/SYMFONY.md +36 -36
  106. package/templates/frameworks/VUE.md +36 -36
  107. package/templates/frameworks/ZEND.md +35 -35
  108. package/templates/git/CI_CD_PATTERNS.md +661 -661
  109. package/templates/git/GITHUB_ACTIONS.md +728 -728
  110. package/templates/git/GITLAB_CI.md +730 -730
  111. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  112. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  113. package/templates/hooks/COMMIT_MSG.md +530 -530
  114. package/templates/hooks/POST_CHECKOUT.md +546 -546
  115. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  116. package/templates/hooks/PRE_COMMIT.md +414 -414
  117. package/templates/hooks/PRE_PUSH.md +601 -601
  118. package/templates/ides/CONTINUE_RULES.md +16 -16
  119. package/templates/ides/COPILOT.md +37 -37
  120. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  121. package/templates/ides/CURSOR.md +43 -43
  122. package/templates/ides/GEMINI_RULES.md +17 -17
  123. package/templates/ides/JETBRAINS_AI.md +35 -35
  124. package/templates/ides/REPLIT.md +36 -36
  125. package/templates/ides/TABNINE.md +29 -29
  126. package/templates/ides/VSCODE.md +40 -40
  127. package/templates/ides/WINDSURF.md +36 -36
  128. package/templates/ides/WINDSURF_RULES.md +14 -14
  129. package/templates/ides/ZED.md +32 -32
  130. package/templates/ides/cursor-mdc/go.mdc +24 -24
  131. package/templates/ides/cursor-mdc/python.mdc +24 -24
  132. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  133. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  134. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  135. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  136. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  137. package/templates/languages/C.md +333 -333
  138. package/templates/languages/CPP.md +743 -743
  139. package/templates/languages/CSHARP.md +417 -417
  140. package/templates/languages/ELIXIR.md +454 -454
  141. package/templates/languages/ERLANG.md +361 -361
  142. package/templates/languages/GO.md +645 -645
  143. package/templates/languages/HASKELL.md +177 -177
  144. package/templates/languages/JAVA.md +607 -607
  145. package/templates/languages/JAVASCRIPT.md +631 -631
  146. package/templates/languages/JULIA.md +97 -97
  147. package/templates/languages/KOTLIN.md +511 -511
  148. package/templates/languages/LISP.md +100 -100
  149. package/templates/languages/LUA.md +74 -74
  150. package/templates/languages/OBJECTIVEC.md +90 -90
  151. package/templates/languages/PHP.md +416 -416
  152. package/templates/languages/PYTHON.md +682 -682
  153. package/templates/languages/RUBY.md +421 -421
  154. package/templates/languages/RUST.md +477 -477
  155. package/templates/languages/SAS.md +73 -73
  156. package/templates/languages/SCALA.md +348 -348
  157. package/templates/languages/SOLIDITY.md +580 -580
  158. package/templates/languages/SQL.md +137 -137
  159. package/templates/languages/SWIFT.md +466 -466
  160. package/templates/languages/TYPESCRIPT.md +591 -591
  161. package/templates/languages/ZIG.md +265 -265
  162. package/templates/modules/ATLASSIAN.md +255 -255
  163. package/templates/modules/CONTEXT7.md +54 -54
  164. package/templates/modules/FIGMA.md +267 -267
  165. package/templates/modules/GITHUB_MCP.md +64 -64
  166. package/templates/modules/GRAFANA.md +328 -328
  167. package/templates/modules/MEMORY.md +126 -126
  168. package/templates/modules/NOTION.md +247 -247
  169. package/templates/modules/PLAYWRIGHT.md +90 -90
  170. package/templates/modules/RULEBOOK_MCP.md +156 -156
  171. package/templates/modules/SERENA.md +337 -337
  172. package/templates/modules/SUPABASE.md +223 -223
  173. package/templates/modules/SYNAP.md +69 -69
  174. package/templates/modules/VECTORIZER.md +63 -63
  175. package/templates/modules/sequential-thinking.md +42 -42
  176. package/templates/ralph/ralph-history.bat +4 -4
  177. package/templates/ralph/ralph-history.sh +5 -5
  178. package/templates/ralph/ralph-init.bat +5 -5
  179. package/templates/ralph/ralph-init.sh +5 -5
  180. package/templates/ralph/ralph-pause.bat +5 -5
  181. package/templates/ralph/ralph-pause.sh +5 -5
  182. package/templates/ralph/ralph-run.bat +5 -5
  183. package/templates/ralph/ralph-run.sh +5 -5
  184. package/templates/ralph/ralph-status.bat +4 -4
  185. package/templates/ralph/ralph-status.sh +5 -5
  186. package/templates/services/AZURE_BLOB.md +184 -184
  187. package/templates/services/CASSANDRA.md +239 -239
  188. package/templates/services/DATADOG.md +26 -26
  189. package/templates/services/DOCKER.md +124 -124
  190. package/templates/services/DOCKER_COMPOSE.md +168 -168
  191. package/templates/services/DYNAMODB.md +308 -308
  192. package/templates/services/ELASTICSEARCH.md +347 -347
  193. package/templates/services/GCS.md +178 -178
  194. package/templates/services/HELM.md +194 -194
  195. package/templates/services/INFLUXDB.md +265 -265
  196. package/templates/services/KAFKA.md +341 -341
  197. package/templates/services/KUBERNETES.md +208 -208
  198. package/templates/services/MARIADB.md +183 -183
  199. package/templates/services/MEMCACHED.md +242 -242
  200. package/templates/services/MINIO.md +201 -201
  201. package/templates/services/MONGODB.md +268 -268
  202. package/templates/services/MYSQL.md +358 -358
  203. package/templates/services/NEO4J.md +247 -247
  204. package/templates/services/OPENTELEMETRY.md +25 -25
  205. package/templates/services/ORACLE.md +290 -290
  206. package/templates/services/PINO.md +24 -24
  207. package/templates/services/POSTGRESQL.md +326 -326
  208. package/templates/services/PROMETHEUS.md +33 -33
  209. package/templates/services/RABBITMQ.md +286 -286
  210. package/templates/services/REDIS.md +292 -292
  211. package/templates/services/S3.md +298 -298
  212. package/templates/services/SENTRY.md +23 -23
  213. package/templates/services/SQLITE.md +294 -294
  214. package/templates/services/SQLSERVER.md +294 -294
  215. package/templates/services/WINSTON.md +30 -30
  216. package/templates/skills/cli/aider/SKILL.md +59 -59
  217. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  218. package/templates/skills/cli/auggie/SKILL.md +42 -42
  219. package/templates/skills/cli/claude/SKILL.md +42 -42
  220. package/templates/skills/cli/cline/SKILL.md +42 -42
  221. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  222. package/templates/skills/cli/codeium/SKILL.md +30 -30
  223. package/templates/skills/cli/codex/SKILL.md +31 -31
  224. package/templates/skills/cli/continue/SKILL.md +44 -44
  225. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  226. package/templates/skills/cli/factory/SKILL.md +28 -28
  227. package/templates/skills/cli/gemini/SKILL.md +45 -45
  228. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  229. package/templates/skills/cli/opencode/SKILL.md +28 -28
  230. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  231. package/templates/skills/core/dag/SKILL.md +314 -314
  232. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  233. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  234. package/templates/skills/core/rulebook/SKILL.md +176 -176
  235. package/templates/skills/dev/accessibility/SKILL.md +17 -0
  236. package/templates/skills/dev/api-design/SKILL.md +15 -0
  237. package/templates/skills/dev/architect/SKILL.md +17 -0
  238. package/templates/skills/dev/build-fix/SKILL.md +17 -0
  239. package/templates/skills/dev/db-design/SKILL.md +15 -0
  240. package/templates/skills/dev/debug/SKILL.md +16 -0
  241. package/templates/skills/dev/deploy/SKILL.md +17 -0
  242. package/templates/skills/dev/docs/SKILL.md +17 -0
  243. package/templates/skills/dev/migrate/SKILL.md +15 -0
  244. package/templates/skills/dev/perf/SKILL.md +17 -0
  245. package/templates/skills/dev/refactor/SKILL.md +17 -0
  246. package/templates/skills/dev/research/SKILL.md +14 -0
  247. package/templates/skills/dev/review/SKILL.md +18 -0
  248. package/templates/skills/dev/security-audit/SKILL.md +17 -0
  249. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  250. package/templates/skills/frameworks/django/SKILL.md +93 -93
  251. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  252. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  253. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  254. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  255. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  256. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  257. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  258. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  259. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  260. package/templates/skills/frameworks/react/SKILL.md +48 -48
  261. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  262. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  263. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  264. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  265. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  266. package/templates/skills/ides/copilot/SKILL.md +47 -47
  267. package/templates/skills/ides/cursor/SKILL.md +53 -53
  268. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  269. package/templates/skills/ides/replit/SKILL.md +46 -46
  270. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  271. package/templates/skills/ides/vscode/SKILL.md +50 -50
  272. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  273. package/templates/skills/ides/zed/SKILL.md +42 -42
  274. package/templates/skills/languages/c/SKILL.md +343 -343
  275. package/templates/skills/languages/cpp/SKILL.md +753 -753
  276. package/templates/skills/languages/csharp/SKILL.md +427 -427
  277. package/templates/skills/languages/elixir/SKILL.md +464 -464
  278. package/templates/skills/languages/erlang/SKILL.md +371 -371
  279. package/templates/skills/languages/go/SKILL.md +655 -655
  280. package/templates/skills/languages/haskell/SKILL.md +187 -187
  281. package/templates/skills/languages/java/SKILL.md +617 -617
  282. package/templates/skills/languages/javascript/SKILL.md +641 -641
  283. package/templates/skills/languages/julia/SKILL.md +107 -107
  284. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  285. package/templates/skills/languages/lisp/SKILL.md +110 -110
  286. package/templates/skills/languages/lua/SKILL.md +84 -84
  287. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  288. package/templates/skills/languages/php/SKILL.md +426 -426
  289. package/templates/skills/languages/python/SKILL.md +692 -692
  290. package/templates/skills/languages/ruby/SKILL.md +431 -431
  291. package/templates/skills/languages/rust/SKILL.md +487 -487
  292. package/templates/skills/languages/sas/SKILL.md +83 -83
  293. package/templates/skills/languages/scala/SKILL.md +358 -358
  294. package/templates/skills/languages/solidity/SKILL.md +590 -590
  295. package/templates/skills/languages/sql/SKILL.md +147 -147
  296. package/templates/skills/languages/swift/SKILL.md +476 -476
  297. package/templates/skills/languages/typescript/SKILL.md +302 -302
  298. package/templates/skills/languages/zig/SKILL.md +275 -275
  299. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  300. package/templates/skills/modules/context7/SKILL.md +64 -64
  301. package/templates/skills/modules/figma/SKILL.md +277 -277
  302. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  303. package/templates/skills/modules/grafana/SKILL.md +338 -338
  304. package/templates/skills/modules/memory/SKILL.md +73 -73
  305. package/templates/skills/modules/notion/SKILL.md +257 -257
  306. package/templates/skills/modules/playwright/SKILL.md +100 -100
  307. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  308. package/templates/skills/modules/serena/SKILL.md +347 -347
  309. package/templates/skills/modules/supabase/SKILL.md +233 -233
  310. package/templates/skills/modules/synap/SKILL.md +79 -79
  311. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  312. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  313. package/templates/skills/services/cassandra/SKILL.md +249 -249
  314. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  315. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  316. package/templates/skills/services/gcs/SKILL.md +188 -188
  317. package/templates/skills/services/influxdb/SKILL.md +275 -275
  318. package/templates/skills/services/kafka/SKILL.md +351 -351
  319. package/templates/skills/services/mariadb/SKILL.md +193 -193
  320. package/templates/skills/services/memcached/SKILL.md +252 -252
  321. package/templates/skills/services/minio/SKILL.md +211 -211
  322. package/templates/skills/services/mongodb/SKILL.md +278 -278
  323. package/templates/skills/services/mysql/SKILL.md +368 -368
  324. package/templates/skills/services/neo4j/SKILL.md +257 -257
  325. package/templates/skills/services/oracle/SKILL.md +300 -300
  326. package/templates/skills/services/postgresql/SKILL.md +336 -336
  327. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  328. package/templates/skills/services/redis/SKILL.md +302 -302
  329. package/templates/skills/services/s3/SKILL.md +308 -308
  330. package/templates/skills/services/sqlite/SKILL.md +304 -304
  331. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  332. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  333. package/templates/skills/workflows/ralph/install.sh +87 -87
  334. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -1,682 +1,682 @@
1
- <!-- PYTHON:START -->
2
- # Python Project Rules
3
-
4
- ## Agent Automation Commands
5
-
6
- **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
7
-
8
- ```bash
9
- # Complete quality check sequence:
10
- ruff format --check . # Format check
11
- ruff check . # Linting
12
- mypy . # Type checking
13
- pytest # All tests (100% pass required)
14
- pytest --cov # Coverage check (95%+ required)
15
-
16
- # Security audit:
17
- pip-audit # Vulnerability scan
18
- pip list --outdated # Check outdated deps
19
- ```
20
-
21
- ## Python Version
22
-
23
- **CRITICAL**: Use Python 3.11+ for modern features and performance.
24
-
25
- - **Minimum Version**: Python 3.11+
26
- - **Recommended**: Python 3.12+
27
- - **Type Hints**: Required for all public APIs
28
-
29
- ### Formatting
30
-
31
- - Use `ruff format` (fast, modern) or `black` (traditional)
32
- - Line length: 100 characters (configurable)
33
- - Consistent formatting across entire project
34
- - Format before committing
35
-
36
- Configuration in `pyproject.toml`:
37
- ```toml
38
- [tool.ruff]
39
- line-length = 100
40
- target-version = "py311"
41
-
42
- [tool.ruff.format]
43
- quote-style = "double"
44
- indent-style = "space"
45
- ```
46
-
47
- ### Linting
48
-
49
- - Use `ruff check` (fast, comprehensive) or `ruff` + `flake8`
50
- - Fix all linting errors before committing
51
- - Document any disabled rules with justification
52
-
53
- Configuration in `pyproject.toml`:
54
- ```toml
55
- [tool.ruff.lint]
56
- select = ["E", "F", "I", "N", "W", "UP", "B", "A", "C4", "SIM"]
57
- ignore = ["E501"] # Line too long (handled by formatter)
58
-
59
- [tool.ruff.lint.per-file-ignores]
60
- "tests/*" = ["S101"] # Allow assert in tests
61
- ```
62
-
63
- ### Type Checking
64
-
65
- - Use `mypy` for static type checking
66
- - All public APIs must have type hints
67
- - Use `typing` module for complex types
68
- - Gradual typing allowed for legacy code
69
-
70
- Configuration in `pyproject.toml`:
71
- ```toml
72
- [tool.mypy]
73
- python_version = "3.11"
74
- strict = true
75
- warn_return_any = true
76
- warn_unused_configs = true
77
- disallow_untyped_defs = true
78
- ```
79
-
80
- Example:
81
- ```python
82
- from typing import Optional, List, Dict, Any
83
-
84
- def process_data(
85
- input_data: str,
86
- options: Optional[Dict[str, Any]] = None
87
- ) -> List[str]:
88
- """Process input data and return results."""
89
- # Implementation
90
- return []
91
- ```
92
-
93
- ### Testing
94
-
95
- - **Framework**: pytest
96
- - **Location**: `/tests` directory
97
- - **Coverage**: Must meet project threshold (default 95%)
98
- - **Fixtures**: Use pytest fixtures for setup/teardown
99
- - **Parametrize**: Use `@pytest.mark.parametrize` for multiple test cases
100
-
101
- Example test structure:
102
- ```python
103
- import pytest
104
- from mymodule import process_data
105
-
106
- @pytest.fixture
107
- def sample_data():
108
- """Provide sample data for tests."""
109
- return "test input"
110
-
111
- def test_process_data_valid_input(sample_data):
112
- """Test process_data with valid input."""
113
- result = process_data(sample_data)
114
- assert result == ["expected"]
115
-
116
- @pytest.mark.parametrize("input_val,expected", [
117
- ("hello", ["HELLO"]),
118
- ("world", ["WORLD"]),
119
- ])
120
- def test_process_data_parametrized(input_val, expected):
121
- """Test multiple input cases."""
122
- result = process_data(input_val)
123
- assert result == expected
124
- ```
125
-
126
- ### Test Categories: S2S and Slow Tests
127
-
128
- **CRITICAL**: Tests must be categorized based on execution time and dependencies.
129
-
130
- #### Test Time Limits
131
-
132
- - **Fast Tests**: Must complete in ≤ 10-20 seconds
133
- - **Slow Tests**: Any test taking > 10-20 seconds must be marked as slow
134
- - **S2S Tests**: Tests requiring active server/database must be isolated and run on-demand
135
-
136
- #### S2S (Server-to-Server) Tests
137
-
138
- **Tests that require active servers, databases, or external services must be isolated using pytest markers.**
139
-
140
- **Implementation**:
141
-
142
- 1. **Mark S2S tests with pytest markers**:
143
- ```python
144
- import pytest
145
- import os
146
-
147
- # Regular fast test (always runs)
148
- def test_local_computation():
149
- """Fast test, no external dependencies."""
150
- result = compute_locally("input")
151
- assert result == "expected"
152
-
153
- # S2S test (only runs with -m s2s)
154
- @pytest.mark.s2s
155
- def test_database_connection():
156
- """Requires active database server."""
157
- db = connect_to_database()
158
- # ... test implementation
159
-
160
- @pytest.mark.s2s
161
- def test_api_integration():
162
- """Requires active API server."""
163
- client = create_api_client()
164
- # ... test implementation
165
- ```
166
-
167
- 2. **Configure `pytest.ini` or `pyproject.toml`**:
168
- ```ini
169
- # pytest.ini
170
- [pytest]
171
- markers =
172
- s2s: Server-to-server tests requiring active services
173
- slow: Slow tests taking > 20 seconds
174
- ```
175
-
176
- Or in `pyproject.toml`:
177
- ```toml
178
- [tool.pytest.ini_options]
179
- markers = [
180
- "s2s: Server-to-server tests requiring active services",
181
- "slow: Slow tests taking > 20 seconds",
182
- ]
183
- ```
184
-
185
- 3. **Run tests**:
186
- ```bash
187
- # Regular tests (excludes S2S)
188
- pytest
189
-
190
- # Include S2S tests (requires active servers)
191
- pytest -m s2s
192
-
193
- # Run all tests including S2S
194
- pytest -m "not slow" # Fast + S2S, excludes slow
195
- ```
196
-
197
- #### Slow Tests
198
-
199
- **Tests that take > 10-20 seconds must be marked and run separately.**
200
-
201
- **Implementation**:
202
-
203
- 1. **Mark slow tests with pytest markers**:
204
- ```python
205
- import pytest
206
-
207
- # Fast test (always runs)
208
- def test_quick_operation():
209
- """Completes in < 1 second."""
210
- result = quick_compute("input")
211
- assert result == "expected"
212
-
213
- # Slow test (only runs with -m slow)
214
- @pytest.mark.slow
215
- def test_heavy_computation():
216
- """Takes 30+ seconds."""
217
- # Heavy processing, large dataset, etc.
218
- result = process_large_dataset()
219
- assert result is not None
220
-
221
- @pytest.mark.slow
222
- def test_large_file_processing():
223
- """Processes large files, takes > 20 seconds."""
224
- result = process_file("large_file.dat")
225
- assert result.success
226
- ```
227
-
228
- 2. **Run tests**:
229
- ```bash
230
- # Regular tests (excludes slow and S2S)
231
- pytest -m "not slow and not s2s"
232
-
233
- # Include slow tests
234
- pytest -m slow
235
-
236
- # Run all tests
237
- pytest -m "" # Empty marker means all tests
238
- ```
239
-
240
- 3. **Add pytest configuration for timeouts**:
241
- ```python
242
- # conftest.py
243
- import pytest
244
-
245
- @pytest.fixture(autouse=True)
246
- def configure_timeouts(request):
247
- """Configure timeouts based on test markers."""
248
- if 'slow' in request.keywords:
249
- request.node.add_marker(pytest.mark.timeout(300)) # 5 minutes
250
- elif 's2s' in request.keywords:
251
- request.node.add_marker(pytest.mark.timeout(60)) # 1 minute
252
- else:
253
- request.node.add_marker(pytest.mark.timeout(20)) # 20 seconds
254
- ```
255
-
256
- 4. **Add scripts in `pyproject.toml` or `setup.py`**:
257
- ```toml
258
- [tool.poetry.scripts]
259
- test = "pytest -m 'not slow and not s2s'"
260
- test-s2s = "pytest -m s2s"
261
- test-slow = "pytest -m slow"
262
- test-all = "pytest"
263
- ```
264
-
265
- #### Best Practices
266
-
267
- - ✅ **Always run fast tests** in CI/CD by default
268
- - ✅ **Isolate S2S tests** - never run them in standard test suite
269
- - ✅ **Mark slow tests** - prevent CI/CD timeouts
270
- - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
271
- - ✅ **Use timeouts** - Set appropriate timeouts: `@pytest.mark.timeout(60)`
272
- - ✅ **Use pytest markers** - `@pytest.mark.s2s` and `@pytest.mark.slow`
273
- - ✅ **Skip conditionally** - `@pytest.mark.skipif(not os.getenv('RUN_S2S_TESTS'), reason='S2S tests disabled')`
274
- - ❌ **Never mix** fast and slow/S2S tests in same test run
275
- - ❌ **Never require** external services for standard test suite
276
- - ❌ **Never exceed** 10-20 seconds for regular tests
277
-
278
- ## Dependency Management
279
-
280
- **CRITICAL**: Use modern dependency management tools.
281
-
282
- ### Recommended: Poetry
283
-
284
- ```toml
285
- [tool.poetry]
286
- name = "myproject"
287
- version = "0.1.0"
288
- description = ""
289
- authors = ["Your Name <you@example.com>"]
290
-
291
- [tool.poetry.dependencies]
292
- python = "^3.11"
293
- requests = "^2.31.0"
294
-
295
- [tool.poetry.group.dev.dependencies]
296
- pytest = "^7.4.0"
297
- mypy = "^1.5.0"
298
- ruff = "^0.1.0"
299
- ```
300
-
301
- Commands:
302
- ```bash
303
- poetry install # Install dependencies
304
- poetry add requests # Add dependency
305
- poetry add --group dev pytest # Add dev dependency
306
- poetry update # Update dependencies
307
- ```
308
-
309
- ### Alternative: pip-tools
310
-
311
- ```
312
- # requirements.in
313
- requests>=2.31.0
314
- pydantic>=2.0.0
315
-
316
- # requirements-dev.in
317
- -r requirements.in
318
- pytest>=7.4.0
319
- mypy>=1.5.0
320
- ```
321
-
322
- Commands:
323
- ```bash
324
- pip-compile requirements.in
325
- pip-compile requirements-dev.in
326
- pip-sync requirements-dev.txt
327
- ```
328
-
329
- ### Dependency Guidelines
330
-
331
- 1. **Check for latest versions**:
332
- - Use Context7 MCP tool if available
333
- - Check PyPI: `pip index versions <package>`
334
- - Review changelog for breaking changes
335
-
336
- 2. **Version pinning**:
337
- - ✅ Pin exact versions in applications
338
- - ✅ Use ranges in libraries (`>=1.0,<2.0`)
339
- - ✅ Keep dependencies updated regularly
340
- - ❌ Don't use outdated packages with security issues
341
-
342
- ## Error Handling
343
-
344
- - Use specific exception types
345
- - Create custom exceptions when needed
346
- - Document exceptions in docstrings
347
- - Never use bare `except:`
348
-
349
- Example:
350
- ```python
351
- class ValidationError(Exception):
352
- """Raised when data validation fails."""
353
-
354
- def __init__(self, message: str, field: str):
355
- super().__init__(message)
356
- self.field = field
357
-
358
- def validate_data(data: dict[str, Any]) -> None:
359
- """
360
- Validate input data.
361
-
362
- Args:
363
- data: The data to validate
364
-
365
- Raises:
366
- ValidationError: If validation fails
367
- """
368
- if not isinstance(data, dict):
369
- raise ValidationError("Data must be a dictionary", "data")
370
- ```
371
-
372
- ## Documentation
373
-
374
- - **Docstrings**: Google or NumPy style
375
- - **Type hints**: Required for public APIs
376
- - **README**: Include installation and usage
377
- - **API docs**: Consider Sphinx for large projects
378
-
379
- Example (Google style):
380
- ```python
381
- def process_data(input_data: str, options: dict[str, Any] | None = None) -> list[str]:
382
- """
383
- Process input data and return results.
384
-
385
- Args:
386
- input_data: The input string to process
387
- options: Optional processing options
388
-
389
- Returns:
390
- A list of processed strings
391
-
392
- Raises:
393
- ValidationError: If input_data is empty
394
-
395
- Examples:
396
- >>> process_data("hello")
397
- ['HELLO']
398
- >>> process_data("world", {"lowercase": True})
399
- ['world']
400
- """
401
- # Implementation
402
- return []
403
- ```
404
-
405
- ## Project Structure
406
-
407
- ```
408
- project/
409
- ├── pyproject.toml # Project metadata and dependencies
410
- ├── README.md # Project overview (allowed in root)
411
- ├── CHANGELOG.md # Version history (allowed in root)
412
- ├── AGENTS.md # AI assistant rules (allowed in root)
413
- ├── LICENSE # Project license (allowed in root)
414
- ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
415
- ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
416
- ├── SECURITY.md # Security policy (allowed in root)
417
- ├── src/
418
- │ └── mypackage/
419
- │ ├── __init__.py
420
- │ ├── module.py
421
- │ └── py.typed # PEP 561 marker for type hints
422
- ├── tests/ # Test files
423
- │ ├── __init__.py
424
- │ └── test_module.py
425
- └── docs/ # Documentation
426
- ```
427
-
428
- ## Async Programming
429
-
430
- - Use `asyncio` for async code
431
- - Type hints: `async def func() -> Coroutine`
432
- - Testing: Use `pytest-asyncio`
433
-
434
- Example:
435
- ```python
436
- import asyncio
437
- from typing import List
438
-
439
- async def fetch_data(url: str) -> dict[str, Any]:
440
- """Fetch data asynchronously."""
441
- # Implementation
442
- return {}
443
-
444
- async def main() -> None:
445
- """Main async function."""
446
- results = await asyncio.gather(
447
- fetch_data("url1"),
448
- fetch_data("url2"),
449
- )
450
- print(results)
451
-
452
- if __name__ == "__main__":
453
- asyncio.run(main())
454
- ```
455
-
456
- ## CI/CD Requirements
457
-
458
- Must include GitHub Actions workflows for:
459
-
460
- 1. **Testing** (`python-test.yml`):
461
- - Test on ubuntu-latest, windows-latest, macos-latest
462
- - Test on Python 3.11, 3.12
463
- - Upload coverage reports
464
-
465
- 2. **Linting** (`python-lint.yml`):
466
- - Format check: `ruff format --check .`
467
- - Lint: `ruff check .`
468
- - Type check: `mypy .`
469
-
470
- 3. **Security** (`python-security.yml`):
471
- - Check for vulnerabilities: `pip-audit`
472
- - Scan dependencies: `safety check`
473
-
474
- ## Package Publication
475
-
476
- ### Publishing to PyPI
477
-
478
- **Prerequisites:**
479
- 1. Create account at https://pypi.org
480
- 2. Enable 2FA for security
481
- 3. Configure trusted publishing (recommended) or create API token
482
- 4. For trusted publishing: Add GitHub as publisher in PyPI settings
483
-
484
- **pyproject.toml Configuration:**
485
-
486
- ```toml
487
- [build-system]
488
- requires = ["setuptools>=68.0", "wheel"]
489
- build-backend = "setuptools.build_meta"
490
-
491
- [project]
492
- name = "your-package-name"
493
- version = "1.0.0"
494
- description = "A short description of your package"
495
- readme = "README.md"
496
- requires-python = ">=3.11"
497
- license = {text = "MIT"}
498
- authors = [
499
- {name = "Your Name", email = "your.email@example.com"}
500
- ]
501
- keywords = ["your", "keywords"]
502
- classifiers = [
503
- "Development Status :: 4 - Beta",
504
- "Intended Audience :: Developers",
505
- "License :: OSI Approved :: MIT License",
506
- "Programming Language :: Python :: 3",
507
- "Programming Language :: Python :: 3.11",
508
- "Programming Language :: Python :: 3.12",
509
- ]
510
- dependencies = [
511
- "requests>=2.31.0",
512
- ]
513
-
514
- [project.optional-dependencies]
515
- dev = [
516
- "pytest>=7.4.0",
517
- "pytest-cov>=4.1.0",
518
- "ruff>=0.1.0",
519
- "mypy>=1.7.0",
520
- "black>=23.12.0",
521
- ]
522
-
523
- [project.urls]
524
- Homepage = "https://github.com/your-org/your-package"
525
- Documentation = "https://your-package.readthedocs.io"
526
- Repository = "https://github.com/your-org/your-package"
527
- "Bug Tracker" = "https://github.com/your-org/your-package/issues"
528
-
529
- [tool.setuptools.packages.find]
530
- where = ["src"]
531
-
532
- [tool.setuptools.package-data]
533
- your_package = ["py.typed"]
534
- ```
535
-
536
- ### PEP 625 Package Naming Convention
537
-
538
- **CRITICAL**: Package names must be normalized according to PEP 625.
539
-
540
- PyPI requires source distribution filenames to use normalized package names (underscores instead of hyphens).
541
-
542
- **Naming Rules:**
543
-
544
- 1. **Package name in `pyproject.toml`**: Use underscores (`_`)
545
- ```toml
546
- [project]
547
- name = "my_package_name" # Correct
548
- # NOT: name = "my-package-name" # Will cause deprecation warning
549
- ```
550
-
551
- 2. **Package directory**: Must match with underscores
552
- ```
553
- src/
554
- └── my_package_name/ # Correct
555
- ├── __init__.py
556
- └── ...
557
- ```
558
-
559
- 3. **Import statement**: Uses underscores
560
- ```python
561
- import my_package_name
562
- from my_package_name import something
563
- ```
564
-
565
- 4. **Distribution filename**: Will be `my_package_name-1.0.0.tar.gz` ✅
566
-
567
- **Common Issue:**
568
-
569
- If you use hyphens in the package name, PyPI will reject new uploads:
570
- ```toml
571
- # ❌ WRONG - Will fail PEP 625 compliance
572
- [project]
573
- name = "my-package-name"
574
-
575
- # Result: my-package-name-1.0.0.tar.gz (non-compliant)
576
- # PyPI Error: "Filename does not contain normalized project name"
577
- ```
578
-
579
- **Correct Approach:**
580
- ```toml
581
- # ✅ CORRECT - PEP 625 compliant
582
- [project]
583
- name = "my_package_name"
584
-
585
- # Result: my_package_name-1.0.0.tar.gz (compliant)
586
- # PyPI: Accepts upload without warnings
587
- ```
588
-
589
- **Migration from Hyphenated Names:**
590
-
591
- If you previously published with hyphens:
592
-
593
- 1. Update `pyproject.toml` and `setup.py` to use underscores
594
- 2. Existing uploads remain on PyPI (no action needed)
595
- 3. Future uploads will use normalized name
596
- 4. PyPI will automatically redirect:
597
- - `pip install my-package-name` → works (auto-normalized)
598
- - `pip install my_package_name` → works (canonical form)
599
- 5. Import statement unchanged: `import my_package_name`
600
-
601
- **Reference**: [PEP 625 - File name of a Source Distribution](https://peps.python.org/pep-0625/)
602
-
603
- **Publishing Workflow:**
604
-
605
- 1. Update version in pyproject.toml
606
- 2. Update CHANGELOG.md
607
- 3. Run quality checks:
608
- ```bash
609
- ruff check .
610
- ruff format --check .
611
- mypy .
612
- pytest
613
- ```
614
- 4. Build package:
615
- ```bash
616
- python -m build
617
- twine check dist/*
618
- ```
619
- 5. Test on Test PyPI (optional):
620
- ```bash
621
- twine upload --repository testpypi dist/*
622
- ```
623
- 6. Create git tag: `git tag v1.0.0 && git push --tags`
624
- 7. GitHub Actions automatically publishes to PyPI
625
- 8. Or manual publish: `twine upload dist/*`
626
-
627
- **Publishing Checklist:**
628
-
629
- - ✅ All tests passing (`pytest`)
630
- - ✅ Type checking passes (`mypy .`)
631
- - ✅ Linting passes (`ruff check .`)
632
- - ✅ Code formatted (`ruff format .`)
633
- - ✅ Version updated in pyproject.toml
634
- - ✅ CHANGELOG.md updated
635
- - ✅ README.md up to date
636
- - ✅ LICENSE file present
637
- - ✅ **Package name uses underscores (PEP 625 compliant)**
638
- - ✅ `py.typed` marker for type hints
639
- - ✅ Package builds successfully (`python -m build`)
640
- - ✅ Package checks pass (`twine check dist/*`)
641
- - ✅ Manifest complete (`check-manifest`)
642
- - ✅ **Verify dist filename**: `my_package-1.0.0.tar.gz` (underscores) ✅
643
-
644
- **Trusted Publishing (Recommended):**
645
-
646
- PyPI trusted publishing eliminates the need for API tokens:
647
-
648
- 1. Go to PyPI → Your Account → Publishing
649
- 2. Add a new pending publisher:
650
- - PyPI Project Name: `your-package-name`
651
- - Owner: `your-github-org`
652
- - Repository: `your-repo-name`
653
- - Workflow: `python-publish.yml`
654
- - Environment: `release` (optional)
655
-
656
- 3. GitHub Actions will authenticate automatically using OIDC
657
-
658
- **Versioning:**
659
-
660
- Use semantic versioning and consider:
661
- - **Automated versioning**: Use tools like `bump2version` or `setuptools_scm`
662
- - **Version from git tags**: Configure `setuptools_scm` in pyproject.toml:
663
-
664
- ```toml
665
- [build-system]
666
- requires = ["setuptools>=68.0", "setuptools_scm>=8.0"]
667
-
668
- [tool.setuptools_scm]
669
- version_file = "src/your_package/_version.py"
670
- ```
671
-
672
- **Type Hints:**
673
-
674
- Include `py.typed` marker for PEP 561 compliance:
675
- ```bash
676
- touch src/your_package/py.typed
677
- ```
678
-
679
- This tells type checkers your package includes type information.
680
-
681
- <!-- PYTHON:END -->
682
-
1
+ <!-- PYTHON:START -->
2
+ # Python Project Rules
3
+
4
+ ## Agent Automation Commands
5
+
6
+ **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
7
+
8
+ ```bash
9
+ # Complete quality check sequence:
10
+ ruff format --check . # Format check
11
+ ruff check . # Linting
12
+ mypy . # Type checking
13
+ pytest # All tests (100% pass required)
14
+ pytest --cov # Coverage check (95%+ required)
15
+
16
+ # Security audit:
17
+ pip-audit # Vulnerability scan
18
+ pip list --outdated # Check outdated deps
19
+ ```
20
+
21
+ ## Python Version
22
+
23
+ **CRITICAL**: Use Python 3.11+ for modern features and performance.
24
+
25
+ - **Minimum Version**: Python 3.11+
26
+ - **Recommended**: Python 3.12+
27
+ - **Type Hints**: Required for all public APIs
28
+
29
+ ### Formatting
30
+
31
+ - Use `ruff format` (fast, modern) or `black` (traditional)
32
+ - Line length: 100 characters (configurable)
33
+ - Consistent formatting across entire project
34
+ - Format before committing
35
+
36
+ Configuration in `pyproject.toml`:
37
+ ```toml
38
+ [tool.ruff]
39
+ line-length = 100
40
+ target-version = "py311"
41
+
42
+ [tool.ruff.format]
43
+ quote-style = "double"
44
+ indent-style = "space"
45
+ ```
46
+
47
+ ### Linting
48
+
49
+ - Use `ruff check` (fast, comprehensive) or `ruff` + `flake8`
50
+ - Fix all linting errors before committing
51
+ - Document any disabled rules with justification
52
+
53
+ Configuration in `pyproject.toml`:
54
+ ```toml
55
+ [tool.ruff.lint]
56
+ select = ["E", "F", "I", "N", "W", "UP", "B", "A", "C4", "SIM"]
57
+ ignore = ["E501"] # Line too long (handled by formatter)
58
+
59
+ [tool.ruff.lint.per-file-ignores]
60
+ "tests/*" = ["S101"] # Allow assert in tests
61
+ ```
62
+
63
+ ### Type Checking
64
+
65
+ - Use `mypy` for static type checking
66
+ - All public APIs must have type hints
67
+ - Use `typing` module for complex types
68
+ - Gradual typing allowed for legacy code
69
+
70
+ Configuration in `pyproject.toml`:
71
+ ```toml
72
+ [tool.mypy]
73
+ python_version = "3.11"
74
+ strict = true
75
+ warn_return_any = true
76
+ warn_unused_configs = true
77
+ disallow_untyped_defs = true
78
+ ```
79
+
80
+ Example:
81
+ ```python
82
+ from typing import Optional, List, Dict, Any
83
+
84
+ def process_data(
85
+ input_data: str,
86
+ options: Optional[Dict[str, Any]] = None
87
+ ) -> List[str]:
88
+ """Process input data and return results."""
89
+ # Implementation
90
+ return []
91
+ ```
92
+
93
+ ### Testing
94
+
95
+ - **Framework**: pytest
96
+ - **Location**: `/tests` directory
97
+ - **Coverage**: Must meet project threshold (default 95%)
98
+ - **Fixtures**: Use pytest fixtures for setup/teardown
99
+ - **Parametrize**: Use `@pytest.mark.parametrize` for multiple test cases
100
+
101
+ Example test structure:
102
+ ```python
103
+ import pytest
104
+ from mymodule import process_data
105
+
106
+ @pytest.fixture
107
+ def sample_data():
108
+ """Provide sample data for tests."""
109
+ return "test input"
110
+
111
+ def test_process_data_valid_input(sample_data):
112
+ """Test process_data with valid input."""
113
+ result = process_data(sample_data)
114
+ assert result == ["expected"]
115
+
116
+ @pytest.mark.parametrize("input_val,expected", [
117
+ ("hello", ["HELLO"]),
118
+ ("world", ["WORLD"]),
119
+ ])
120
+ def test_process_data_parametrized(input_val, expected):
121
+ """Test multiple input cases."""
122
+ result = process_data(input_val)
123
+ assert result == expected
124
+ ```
125
+
126
+ ### Test Categories: S2S and Slow Tests
127
+
128
+ **CRITICAL**: Tests must be categorized based on execution time and dependencies.
129
+
130
+ #### Test Time Limits
131
+
132
+ - **Fast Tests**: Must complete in ≤ 10-20 seconds
133
+ - **Slow Tests**: Any test taking > 10-20 seconds must be marked as slow
134
+ - **S2S Tests**: Tests requiring active server/database must be isolated and run on-demand
135
+
136
+ #### S2S (Server-to-Server) Tests
137
+
138
+ **Tests that require active servers, databases, or external services must be isolated using pytest markers.**
139
+
140
+ **Implementation**:
141
+
142
+ 1. **Mark S2S tests with pytest markers**:
143
+ ```python
144
+ import pytest
145
+ import os
146
+
147
+ # Regular fast test (always runs)
148
+ def test_local_computation():
149
+ """Fast test, no external dependencies."""
150
+ result = compute_locally("input")
151
+ assert result == "expected"
152
+
153
+ # S2S test (only runs with -m s2s)
154
+ @pytest.mark.s2s
155
+ def test_database_connection():
156
+ """Requires active database server."""
157
+ db = connect_to_database()
158
+ # ... test implementation
159
+
160
+ @pytest.mark.s2s
161
+ def test_api_integration():
162
+ """Requires active API server."""
163
+ client = create_api_client()
164
+ # ... test implementation
165
+ ```
166
+
167
+ 2. **Configure `pytest.ini` or `pyproject.toml`**:
168
+ ```ini
169
+ # pytest.ini
170
+ [pytest]
171
+ markers =
172
+ s2s: Server-to-server tests requiring active services
173
+ slow: Slow tests taking > 20 seconds
174
+ ```
175
+
176
+ Or in `pyproject.toml`:
177
+ ```toml
178
+ [tool.pytest.ini_options]
179
+ markers = [
180
+ "s2s: Server-to-server tests requiring active services",
181
+ "slow: Slow tests taking > 20 seconds",
182
+ ]
183
+ ```
184
+
185
+ 3. **Run tests**:
186
+ ```bash
187
+ # Regular tests (excludes S2S)
188
+ pytest
189
+
190
+ # Include S2S tests (requires active servers)
191
+ pytest -m s2s
192
+
193
+ # Run all tests including S2S
194
+ pytest -m "not slow" # Fast + S2S, excludes slow
195
+ ```
196
+
197
+ #### Slow Tests
198
+
199
+ **Tests that take > 10-20 seconds must be marked and run separately.**
200
+
201
+ **Implementation**:
202
+
203
+ 1. **Mark slow tests with pytest markers**:
204
+ ```python
205
+ import pytest
206
+
207
+ # Fast test (always runs)
208
+ def test_quick_operation():
209
+ """Completes in < 1 second."""
210
+ result = quick_compute("input")
211
+ assert result == "expected"
212
+
213
+ # Slow test (only runs with -m slow)
214
+ @pytest.mark.slow
215
+ def test_heavy_computation():
216
+ """Takes 30+ seconds."""
217
+ # Heavy processing, large dataset, etc.
218
+ result = process_large_dataset()
219
+ assert result is not None
220
+
221
+ @pytest.mark.slow
222
+ def test_large_file_processing():
223
+ """Processes large files, takes > 20 seconds."""
224
+ result = process_file("large_file.dat")
225
+ assert result.success
226
+ ```
227
+
228
+ 2. **Run tests**:
229
+ ```bash
230
+ # Regular tests (excludes slow and S2S)
231
+ pytest -m "not slow and not s2s"
232
+
233
+ # Include slow tests
234
+ pytest -m slow
235
+
236
+ # Run all tests
237
+ pytest -m "" # Empty marker means all tests
238
+ ```
239
+
240
+ 3. **Add pytest configuration for timeouts**:
241
+ ```python
242
+ # conftest.py
243
+ import pytest
244
+
245
+ @pytest.fixture(autouse=True)
246
+ def configure_timeouts(request):
247
+ """Configure timeouts based on test markers."""
248
+ if 'slow' in request.keywords:
249
+ request.node.add_marker(pytest.mark.timeout(300)) # 5 minutes
250
+ elif 's2s' in request.keywords:
251
+ request.node.add_marker(pytest.mark.timeout(60)) # 1 minute
252
+ else:
253
+ request.node.add_marker(pytest.mark.timeout(20)) # 20 seconds
254
+ ```
255
+
256
+ 4. **Add scripts in `pyproject.toml` or `setup.py`**:
257
+ ```toml
258
+ [tool.poetry.scripts]
259
+ test = "pytest -m 'not slow and not s2s'"
260
+ test-s2s = "pytest -m s2s"
261
+ test-slow = "pytest -m slow"
262
+ test-all = "pytest"
263
+ ```
264
+
265
+ #### Best Practices
266
+
267
+ - ✅ **Always run fast tests** in CI/CD by default
268
+ - ✅ **Isolate S2S tests** - never run them in standard test suite
269
+ - ✅ **Mark slow tests** - prevent CI/CD timeouts
270
+ - ✅ **Document requirements** - specify which servers/services are needed for S2S tests
271
+ - ✅ **Use timeouts** - Set appropriate timeouts: `@pytest.mark.timeout(60)`
272
+ - ✅ **Use pytest markers** - `@pytest.mark.s2s` and `@pytest.mark.slow`
273
+ - ✅ **Skip conditionally** - `@pytest.mark.skipif(not os.getenv('RUN_S2S_TESTS'), reason='S2S tests disabled')`
274
+ - ❌ **Never mix** fast and slow/S2S tests in same test run
275
+ - ❌ **Never require** external services for standard test suite
276
+ - ❌ **Never exceed** 10-20 seconds for regular tests
277
+
278
+ ## Dependency Management
279
+
280
+ **CRITICAL**: Use modern dependency management tools.
281
+
282
+ ### Recommended: Poetry
283
+
284
+ ```toml
285
+ [tool.poetry]
286
+ name = "myproject"
287
+ version = "0.1.0"
288
+ description = ""
289
+ authors = ["Your Name <you@example.com>"]
290
+
291
+ [tool.poetry.dependencies]
292
+ python = "^3.11"
293
+ requests = "^2.31.0"
294
+
295
+ [tool.poetry.group.dev.dependencies]
296
+ pytest = "^7.4.0"
297
+ mypy = "^1.5.0"
298
+ ruff = "^0.1.0"
299
+ ```
300
+
301
+ Commands:
302
+ ```bash
303
+ poetry install # Install dependencies
304
+ poetry add requests # Add dependency
305
+ poetry add --group dev pytest # Add dev dependency
306
+ poetry update # Update dependencies
307
+ ```
308
+
309
+ ### Alternative: pip-tools
310
+
311
+ ```
312
+ # requirements.in
313
+ requests>=2.31.0
314
+ pydantic>=2.0.0
315
+
316
+ # requirements-dev.in
317
+ -r requirements.in
318
+ pytest>=7.4.0
319
+ mypy>=1.5.0
320
+ ```
321
+
322
+ Commands:
323
+ ```bash
324
+ pip-compile requirements.in
325
+ pip-compile requirements-dev.in
326
+ pip-sync requirements-dev.txt
327
+ ```
328
+
329
+ ### Dependency Guidelines
330
+
331
+ 1. **Check for latest versions**:
332
+ - Use Context7 MCP tool if available
333
+ - Check PyPI: `pip index versions <package>`
334
+ - Review changelog for breaking changes
335
+
336
+ 2. **Version pinning**:
337
+ - ✅ Pin exact versions in applications
338
+ - ✅ Use ranges in libraries (`>=1.0,<2.0`)
339
+ - ✅ Keep dependencies updated regularly
340
+ - ❌ Don't use outdated packages with security issues
341
+
342
+ ## Error Handling
343
+
344
+ - Use specific exception types
345
+ - Create custom exceptions when needed
346
+ - Document exceptions in docstrings
347
+ - Never use bare `except:`
348
+
349
+ Example:
350
+ ```python
351
+ class ValidationError(Exception):
352
+ """Raised when data validation fails."""
353
+
354
+ def __init__(self, message: str, field: str):
355
+ super().__init__(message)
356
+ self.field = field
357
+
358
+ def validate_data(data: dict[str, Any]) -> None:
359
+ """
360
+ Validate input data.
361
+
362
+ Args:
363
+ data: The data to validate
364
+
365
+ Raises:
366
+ ValidationError: If validation fails
367
+ """
368
+ if not isinstance(data, dict):
369
+ raise ValidationError("Data must be a dictionary", "data")
370
+ ```
371
+
372
+ ## Documentation
373
+
374
+ - **Docstrings**: Google or NumPy style
375
+ - **Type hints**: Required for public APIs
376
+ - **README**: Include installation and usage
377
+ - **API docs**: Consider Sphinx for large projects
378
+
379
+ Example (Google style):
380
+ ```python
381
+ def process_data(input_data: str, options: dict[str, Any] | None = None) -> list[str]:
382
+ """
383
+ Process input data and return results.
384
+
385
+ Args:
386
+ input_data: The input string to process
387
+ options: Optional processing options
388
+
389
+ Returns:
390
+ A list of processed strings
391
+
392
+ Raises:
393
+ ValidationError: If input_data is empty
394
+
395
+ Examples:
396
+ >>> process_data("hello")
397
+ ['HELLO']
398
+ >>> process_data("world", {"lowercase": True})
399
+ ['world']
400
+ """
401
+ # Implementation
402
+ return []
403
+ ```
404
+
405
+ ## Project Structure
406
+
407
+ ```
408
+ project/
409
+ ├── pyproject.toml # Project metadata and dependencies
410
+ ├── README.md # Project overview (allowed in root)
411
+ ├── CHANGELOG.md # Version history (allowed in root)
412
+ ├── AGENTS.md # AI assistant rules (allowed in root)
413
+ ├── LICENSE # Project license (allowed in root)
414
+ ├── CONTRIBUTING.md # Contribution guidelines (allowed in root)
415
+ ├── CODE_OF_CONDUCT.md # Code of conduct (allowed in root)
416
+ ├── SECURITY.md # Security policy (allowed in root)
417
+ ├── src/
418
+ │ └── mypackage/
419
+ │ ├── __init__.py
420
+ │ ├── module.py
421
+ │ └── py.typed # PEP 561 marker for type hints
422
+ ├── tests/ # Test files
423
+ │ ├── __init__.py
424
+ │ └── test_module.py
425
+ └── docs/ # Documentation
426
+ ```
427
+
428
+ ## Async Programming
429
+
430
+ - Use `asyncio` for async code
431
+ - Type hints: `async def func() -> Coroutine`
432
+ - Testing: Use `pytest-asyncio`
433
+
434
+ Example:
435
+ ```python
436
+ import asyncio
437
+ from typing import List
438
+
439
+ async def fetch_data(url: str) -> dict[str, Any]:
440
+ """Fetch data asynchronously."""
441
+ # Implementation
442
+ return {}
443
+
444
+ async def main() -> None:
445
+ """Main async function."""
446
+ results = await asyncio.gather(
447
+ fetch_data("url1"),
448
+ fetch_data("url2"),
449
+ )
450
+ print(results)
451
+
452
+ if __name__ == "__main__":
453
+ asyncio.run(main())
454
+ ```
455
+
456
+ ## CI/CD Requirements
457
+
458
+ Must include GitHub Actions workflows for:
459
+
460
+ 1. **Testing** (`python-test.yml`):
461
+ - Test on ubuntu-latest, windows-latest, macos-latest
462
+ - Test on Python 3.11, 3.12
463
+ - Upload coverage reports
464
+
465
+ 2. **Linting** (`python-lint.yml`):
466
+ - Format check: `ruff format --check .`
467
+ - Lint: `ruff check .`
468
+ - Type check: `mypy .`
469
+
470
+ 3. **Security** (`python-security.yml`):
471
+ - Check for vulnerabilities: `pip-audit`
472
+ - Scan dependencies: `safety check`
473
+
474
+ ## Package Publication
475
+
476
+ ### Publishing to PyPI
477
+
478
+ **Prerequisites:**
479
+ 1. Create account at https://pypi.org
480
+ 2. Enable 2FA for security
481
+ 3. Configure trusted publishing (recommended) or create API token
482
+ 4. For trusted publishing: Add GitHub as publisher in PyPI settings
483
+
484
+ **pyproject.toml Configuration:**
485
+
486
+ ```toml
487
+ [build-system]
488
+ requires = ["setuptools>=68.0", "wheel"]
489
+ build-backend = "setuptools.build_meta"
490
+
491
+ [project]
492
+ name = "your-package-name"
493
+ version = "1.0.0"
494
+ description = "A short description of your package"
495
+ readme = "README.md"
496
+ requires-python = ">=3.11"
497
+ license = {text = "MIT"}
498
+ authors = [
499
+ {name = "Your Name", email = "your.email@example.com"}
500
+ ]
501
+ keywords = ["your", "keywords"]
502
+ classifiers = [
503
+ "Development Status :: 4 - Beta",
504
+ "Intended Audience :: Developers",
505
+ "License :: OSI Approved :: MIT License",
506
+ "Programming Language :: Python :: 3",
507
+ "Programming Language :: Python :: 3.11",
508
+ "Programming Language :: Python :: 3.12",
509
+ ]
510
+ dependencies = [
511
+ "requests>=2.31.0",
512
+ ]
513
+
514
+ [project.optional-dependencies]
515
+ dev = [
516
+ "pytest>=7.4.0",
517
+ "pytest-cov>=4.1.0",
518
+ "ruff>=0.1.0",
519
+ "mypy>=1.7.0",
520
+ "black>=23.12.0",
521
+ ]
522
+
523
+ [project.urls]
524
+ Homepage = "https://github.com/your-org/your-package"
525
+ Documentation = "https://your-package.readthedocs.io"
526
+ Repository = "https://github.com/your-org/your-package"
527
+ "Bug Tracker" = "https://github.com/your-org/your-package/issues"
528
+
529
+ [tool.setuptools.packages.find]
530
+ where = ["src"]
531
+
532
+ [tool.setuptools.package-data]
533
+ your_package = ["py.typed"]
534
+ ```
535
+
536
+ ### PEP 625 Package Naming Convention
537
+
538
+ **CRITICAL**: Package names must be normalized according to PEP 625.
539
+
540
+ PyPI requires source distribution filenames to use normalized package names (underscores instead of hyphens).
541
+
542
+ **Naming Rules:**
543
+
544
+ 1. **Package name in `pyproject.toml`**: Use underscores (`_`)
545
+ ```toml
546
+ [project]
547
+ name = "my_package_name" # Correct
548
+ # NOT: name = "my-package-name" # Will cause deprecation warning
549
+ ```
550
+
551
+ 2. **Package directory**: Must match with underscores
552
+ ```
553
+ src/
554
+ └── my_package_name/ # Correct
555
+ ├── __init__.py
556
+ └── ...
557
+ ```
558
+
559
+ 3. **Import statement**: Uses underscores
560
+ ```python
561
+ import my_package_name
562
+ from my_package_name import something
563
+ ```
564
+
565
+ 4. **Distribution filename**: Will be `my_package_name-1.0.0.tar.gz` ✅
566
+
567
+ **Common Issue:**
568
+
569
+ If you use hyphens in the package name, PyPI will reject new uploads:
570
+ ```toml
571
+ # ❌ WRONG - Will fail PEP 625 compliance
572
+ [project]
573
+ name = "my-package-name"
574
+
575
+ # Result: my-package-name-1.0.0.tar.gz (non-compliant)
576
+ # PyPI Error: "Filename does not contain normalized project name"
577
+ ```
578
+
579
+ **Correct Approach:**
580
+ ```toml
581
+ # ✅ CORRECT - PEP 625 compliant
582
+ [project]
583
+ name = "my_package_name"
584
+
585
+ # Result: my_package_name-1.0.0.tar.gz (compliant)
586
+ # PyPI: Accepts upload without warnings
587
+ ```
588
+
589
+ **Migration from Hyphenated Names:**
590
+
591
+ If you previously published with hyphens:
592
+
593
+ 1. Update `pyproject.toml` and `setup.py` to use underscores
594
+ 2. Existing uploads remain on PyPI (no action needed)
595
+ 3. Future uploads will use normalized name
596
+ 4. PyPI will automatically redirect:
597
+ - `pip install my-package-name` → works (auto-normalized)
598
+ - `pip install my_package_name` → works (canonical form)
599
+ 5. Import statement unchanged: `import my_package_name`
600
+
601
+ **Reference**: [PEP 625 - File name of a Source Distribution](https://peps.python.org/pep-0625/)
602
+
603
+ **Publishing Workflow:**
604
+
605
+ 1. Update version in pyproject.toml
606
+ 2. Update CHANGELOG.md
607
+ 3. Run quality checks:
608
+ ```bash
609
+ ruff check .
610
+ ruff format --check .
611
+ mypy .
612
+ pytest
613
+ ```
614
+ 4. Build package:
615
+ ```bash
616
+ python -m build
617
+ twine check dist/*
618
+ ```
619
+ 5. Test on Test PyPI (optional):
620
+ ```bash
621
+ twine upload --repository testpypi dist/*
622
+ ```
623
+ 6. Create git tag: `git tag v1.0.0 && git push --tags`
624
+ 7. GitHub Actions automatically publishes to PyPI
625
+ 8. Or manual publish: `twine upload dist/*`
626
+
627
+ **Publishing Checklist:**
628
+
629
+ - ✅ All tests passing (`pytest`)
630
+ - ✅ Type checking passes (`mypy .`)
631
+ - ✅ Linting passes (`ruff check .`)
632
+ - ✅ Code formatted (`ruff format .`)
633
+ - ✅ Version updated in pyproject.toml
634
+ - ✅ CHANGELOG.md updated
635
+ - ✅ README.md up to date
636
+ - ✅ LICENSE file present
637
+ - ✅ **Package name uses underscores (PEP 625 compliant)**
638
+ - ✅ `py.typed` marker for type hints
639
+ - ✅ Package builds successfully (`python -m build`)
640
+ - ✅ Package checks pass (`twine check dist/*`)
641
+ - ✅ Manifest complete (`check-manifest`)
642
+ - ✅ **Verify dist filename**: `my_package-1.0.0.tar.gz` (underscores) ✅
643
+
644
+ **Trusted Publishing (Recommended):**
645
+
646
+ PyPI trusted publishing eliminates the need for API tokens:
647
+
648
+ 1. Go to PyPI → Your Account → Publishing
649
+ 2. Add a new pending publisher:
650
+ - PyPI Project Name: `your-package-name`
651
+ - Owner: `your-github-org`
652
+ - Repository: `your-repo-name`
653
+ - Workflow: `python-publish.yml`
654
+ - Environment: `release` (optional)
655
+
656
+ 3. GitHub Actions will authenticate automatically using OIDC
657
+
658
+ **Versioning:**
659
+
660
+ Use semantic versioning and consider:
661
+ - **Automated versioning**: Use tools like `bump2version` or `setuptools_scm`
662
+ - **Version from git tags**: Configure `setuptools_scm` in pyproject.toml:
663
+
664
+ ```toml
665
+ [build-system]
666
+ requires = ["setuptools>=68.0", "setuptools_scm>=8.0"]
667
+
668
+ [tool.setuptools_scm]
669
+ version_file = "src/your_package/_version.py"
670
+ ```
671
+
672
+ **Type Hints:**
673
+
674
+ Include `py.typed` marker for PEP 561 compliance:
675
+ ```bash
676
+ touch src/your_package/py.typed
677
+ ```
678
+
679
+ This tells type checkers your package includes type information.
680
+
681
+ <!-- PYTHON:END -->
682
+