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