codeply-cli 0.3.1 → 0.4.1

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 (375) hide show
  1. package/THIRD_PARTY_NOTICES.md +63 -63
  2. package/bin/codeply.js +127 -0
  3. package/lib/agent.mjs +2139 -2139
  4. package/lib/ai.mjs +6 -6
  5. package/lib/apply-patch.js +217 -217
  6. package/lib/arity-table.json +138 -138
  7. package/lib/arity.js +70 -70
  8. package/lib/auth.mjs +6 -6
  9. package/lib/cloud.mjs +796 -0
  10. package/lib/commands.js +103 -103
  11. package/lib/design-library/assemble-artifact.mjs +21 -21
  12. package/lib/design-library/cleanup.mjs +45 -45
  13. package/lib/design-library/index.json +22379 -22379
  14. package/lib/design-library/make-table-data.mjs +39 -39
  15. package/lib/diagnostics.js +192 -192
  16. package/lib/edit-engine.js +364 -364
  17. package/lib/github-agent.mjs +311 -307
  18. package/lib/history.js +75 -75
  19. package/lib/mcp.js +258 -258
  20. package/lib/native-tools.mjs +189 -189
  21. package/lib/oauth-connectors.js +2 -1
  22. package/lib/permissions.js +109 -109
  23. package/lib/plugins.js +353 -353
  24. package/lib/server.mjs +457 -457
  25. package/lib/session-db.js +220 -220
  26. package/lib/share.js +168 -168
  27. package/lib/skills.js +416 -416
  28. package/lib/snapshot.js +146 -146
  29. package/lib/terminal-hints.js +154 -154
  30. package/lib/tools.mjs +2012 -2012
  31. package/lib/typecheck-worker.js +147 -147
  32. package/lib/web-tools.js +158 -158
  33. package/package.json +49 -47
  34. package/skills/SOURCE.md +58 -58
  35. package/skills/accessibility/SKILL.md +147 -147
  36. package/skills/agent-architecture-audit/SKILL.md +257 -257
  37. package/skills/agent-eval/SKILL.md +147 -147
  38. package/skills/agent-harness-construction/SKILL.md +74 -74
  39. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  40. package/skills/agent-payment-x402/SKILL.md +225 -225
  41. package/skills/agent-self-evaluation/SKILL.md +182 -182
  42. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  43. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  44. package/skills/agent-sort/SKILL.md +216 -216
  45. package/skills/agentic-engineering/SKILL.md +64 -64
  46. package/skills/agentic-os/SKILL.md +388 -388
  47. package/skills/ai-first-engineering/SKILL.md +52 -52
  48. package/skills/ai-regression-testing/SKILL.md +386 -386
  49. package/skills/android-clean-architecture/SKILL.md +340 -340
  50. package/skills/angular-developer/SKILL.md +155 -155
  51. package/skills/angular-developer/references/angular-animations.md +160 -160
  52. package/skills/angular-developer/references/angular-aria.md +410 -410
  53. package/skills/angular-developer/references/cli.md +86 -86
  54. package/skills/angular-developer/references/component-harnesses.md +59 -59
  55. package/skills/angular-developer/references/component-styling.md +91 -91
  56. package/skills/angular-developer/references/components.md +117 -117
  57. package/skills/angular-developer/references/creating-services.md +97 -97
  58. package/skills/angular-developer/references/data-resolvers.md +69 -69
  59. package/skills/angular-developer/references/define-routes.md +67 -67
  60. package/skills/angular-developer/references/defining-providers.md +72 -72
  61. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  62. package/skills/angular-developer/references/e2e-testing.md +56 -56
  63. package/skills/angular-developer/references/effects.md +83 -83
  64. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  65. package/skills/angular-developer/references/host-elements.md +80 -80
  66. package/skills/angular-developer/references/injection-context.md +63 -63
  67. package/skills/angular-developer/references/inputs.md +101 -101
  68. package/skills/angular-developer/references/linked-signal.md +59 -59
  69. package/skills/angular-developer/references/loading-strategies.md +61 -61
  70. package/skills/angular-developer/references/mcp.md +108 -108
  71. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  72. package/skills/angular-developer/references/outputs.md +86 -86
  73. package/skills/angular-developer/references/reactive-forms.md +122 -122
  74. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  75. package/skills/angular-developer/references/resource.md +77 -77
  76. package/skills/angular-developer/references/route-animations.md +56 -56
  77. package/skills/angular-developer/references/route-guards.md +52 -52
  78. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  79. package/skills/angular-developer/references/router-testing.md +87 -87
  80. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  81. package/skills/angular-developer/references/signal-forms.md +795 -795
  82. package/skills/angular-developer/references/signals-overview.md +94 -94
  83. package/skills/angular-developer/references/tailwind-css.md +69 -69
  84. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  85. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  86. package/skills/api-connector-builder/SKILL.md +121 -121
  87. package/skills/api-design/SKILL.md +524 -524
  88. package/skills/architecture-decision-records/SKILL.md +180 -180
  89. package/skills/article-writing/SKILL.md +80 -80
  90. package/skills/automation-audit-ops/SKILL.md +143 -143
  91. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  92. package/skills/autonomous-loops/SKILL.md +611 -611
  93. package/skills/backend-patterns/SKILL.md +562 -562
  94. package/skills/benchmark/SKILL.md +95 -95
  95. package/skills/benchmark-methodology/SKILL.md +191 -191
  96. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  97. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  98. package/skills/blueprint/SKILL.md +106 -106
  99. package/skills/brand-discovery/SKILL.md +145 -145
  100. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  101. package/skills/brand-discovery/references/20_positioning.md +44 -44
  102. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  103. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  104. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  105. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  106. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  107. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  108. package/skills/brand-voice/SKILL.md +98 -98
  109. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  110. package/skills/browser-qa/SKILL.md +105 -105
  111. package/skills/bun-runtime/SKILL.md +85 -85
  112. package/skills/canary-watch/SKILL.md +108 -108
  113. package/skills/carrier-relationship-management/SKILL.md +212 -212
  114. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  115. package/skills/ck/SKILL.md +148 -148
  116. package/skills/claude-devfleet/SKILL.md +112 -112
  117. package/skills/click-path-audit/SKILL.md +245 -245
  118. package/skills/clickhouse-io/SKILL.md +445 -445
  119. package/skills/code-tour/SKILL.md +254 -254
  120. package/skills/codebase-onboarding/SKILL.md +234 -234
  121. package/skills/codehealth-mcp/SKILL.md +167 -167
  122. package/skills/coding-standards/SKILL.md +551 -551
  123. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  124. package/skills/competitive-report-structure/SKILL.md +162 -162
  125. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  126. package/skills/config-gc/SKILL.md +120 -120
  127. package/skills/configure-ecc/SKILL.md +385 -385
  128. package/skills/connections-optimizer/SKILL.md +190 -190
  129. package/skills/content-engine/SKILL.md +132 -132
  130. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  131. package/skills/context-budget/SKILL.md +136 -136
  132. package/skills/continuous-agent-loop/SKILL.md +46 -46
  133. package/skills/continuous-learning/SKILL.md +132 -132
  134. package/skills/continuous-learning-v2/SKILL.md +361 -361
  135. package/skills/contract-first/SKILL.md +287 -287
  136. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  137. package/skills/cost-tracking/SKILL.md +97 -97
  138. package/skills/council/SKILL.md +204 -204
  139. package/skills/cpp-coding-standards/SKILL.md +724 -724
  140. package/skills/cpp-testing/SKILL.md +325 -325
  141. package/skills/crosspost/SKILL.md +112 -112
  142. package/skills/csharp-testing/SKILL.md +322 -322
  143. package/skills/customer-billing-ops/SKILL.md +141 -141
  144. package/skills/customs-trade-compliance/SKILL.md +263 -263
  145. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  146. package/skills/dashboard-builder/SKILL.md +109 -109
  147. package/skills/data-scraper-agent/SKILL.md +765 -765
  148. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  149. package/skills/database-migrations/SKILL.md +430 -430
  150. package/skills/deep-research/SKILL.md +160 -160
  151. package/skills/defi-amm-security/SKILL.md +167 -167
  152. package/skills/delivery-gate/SKILL.md +126 -126
  153. package/skills/deployment-patterns/SKILL.md +428 -428
  154. package/skills/design-system/SKILL.md +83 -83
  155. package/skills/django-celery/SKILL.md +458 -458
  156. package/skills/django-patterns/SKILL.md +735 -735
  157. package/skills/django-security/SKILL.md +644 -644
  158. package/skills/django-tdd/SKILL.md +730 -730
  159. package/skills/django-verification/SKILL.md +470 -470
  160. package/skills/dmux-workflows/SKILL.md +192 -192
  161. package/skills/docker-patterns/SKILL.md +365 -365
  162. package/skills/documentation-lookup/SKILL.md +91 -91
  163. package/skills/dotnet-patterns/SKILL.md +322 -322
  164. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  165. package/skills/e2e-testing/SKILL.md +327 -327
  166. package/skills/ecc-guide/SKILL.md +190 -190
  167. package/skills/ecc-recipes/SKILL.md +149 -149
  168. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  169. package/skills/email-ops/SKILL.md +122 -122
  170. package/skills/energy-procurement/SKILL.md +228 -228
  171. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  172. package/skills/error-handling/SKILL.md +377 -377
  173. package/skills/eval-harness/SKILL.md +271 -271
  174. package/skills/evm-token-decimals/SKILL.md +131 -131
  175. package/skills/exa-search/SKILL.md +108 -108
  176. package/skills/fal-ai-media/SKILL.md +289 -289
  177. package/skills/fastapi-patterns/SKILL.md +514 -514
  178. package/skills/finance-billing-ops/SKILL.md +128 -128
  179. package/skills/flox-environments/SKILL.md +497 -497
  180. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  181. package/skills/foundation-models-on-device/SKILL.md +243 -243
  182. package/skills/frontend-a11y/SKILL.md +446 -446
  183. package/skills/frontend-design-direction/SKILL.md +93 -93
  184. package/skills/frontend-patterns/SKILL.md +657 -657
  185. package/skills/frontend-slides/SKILL.md +185 -185
  186. package/skills/fsharp-testing/SKILL.md +281 -281
  187. package/skills/gan-style-harness/SKILL.md +279 -279
  188. package/skills/gateguard/SKILL.md +133 -133
  189. package/skills/generating-python-installer/SKILL.md +820 -820
  190. package/skills/git-workflow/SKILL.md +716 -716
  191. package/skills/github-ops/SKILL.md +145 -145
  192. package/skills/golang-patterns/SKILL.md +676 -676
  193. package/skills/golang-testing/SKILL.md +721 -721
  194. package/skills/google-workspace-ops/SKILL.md +96 -96
  195. package/skills/growth-log/SKILL.md +128 -128
  196. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  197. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  198. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  199. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  200. package/skills/hermes-imports/SKILL.md +89 -89
  201. package/skills/hexagonal-architecture/SKILL.md +277 -277
  202. package/skills/hipaa-compliance/SKILL.md +79 -79
  203. package/skills/homelab-network-readiness/SKILL.md +170 -170
  204. package/skills/homelab-network-setup/SKILL.md +130 -130
  205. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  206. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  207. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  208. package/skills/hookify-rules/SKILL.md +128 -128
  209. package/skills/inherit-legacy-style/SKILL.md +157 -157
  210. package/skills/intent-driven-development/SKILL.md +360 -360
  211. package/skills/inventory-demand-planning/SKILL.md +247 -247
  212. package/skills/investor-materials/SKILL.md +97 -97
  213. package/skills/investor-outreach/SKILL.md +92 -92
  214. package/skills/ios-icon-gen/SKILL.md +158 -158
  215. package/skills/iterative-retrieval/SKILL.md +212 -212
  216. package/skills/ito-basket-compare/SKILL.md +64 -64
  217. package/skills/ito-compute/SKILL.md +129 -129
  218. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  219. package/skills/ito-market-intelligence/SKILL.md +61 -61
  220. package/skills/ito-trade-planner/SKILL.md +68 -68
  221. package/skills/java-coding-standards/SKILL.md +384 -384
  222. package/skills/jira-integration/SKILL.md +303 -303
  223. package/skills/jpa-patterns/SKILL.md +152 -152
  224. package/skills/knowledge-ops/SKILL.md +155 -155
  225. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  226. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  227. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  228. package/skills/kotlin-patterns/SKILL.md +712 -712
  229. package/skills/kotlin-testing/SKILL.md +825 -825
  230. package/skills/kubernetes-patterns/SKILL.md +756 -756
  231. package/skills/laravel-patterns/SKILL.md +416 -416
  232. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  233. package/skills/laravel-security/SKILL.md +948 -948
  234. package/skills/laravel-tdd/SKILL.md +675 -675
  235. package/skills/laravel-verification/SKILL.md +180 -180
  236. package/skills/latency-critical-systems/SKILL.md +75 -75
  237. package/skills/lead-intelligence/SKILL.md +322 -322
  238. package/skills/liquid-glass-design/SKILL.md +279 -279
  239. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  240. package/skills/logistics-exception-management/SKILL.md +222 -222
  241. package/skills/loop-design-check/SKILL.md +143 -143
  242. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  243. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  244. package/skills/manim-video/SKILL.md +90 -90
  245. package/skills/market-research/SKILL.md +76 -76
  246. package/skills/marketing-campaign/SKILL.md +114 -114
  247. package/skills/mcp-server-patterns/SKILL.md +70 -70
  248. package/skills/messages-ops/SKILL.md +105 -105
  249. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  250. package/skills/mle-workflow/SKILL.md +348 -348
  251. package/skills/motion-advanced/SKILL.md +596 -596
  252. package/skills/motion-foundations/SKILL.md +299 -299
  253. package/skills/motion-patterns/SKILL.md +434 -434
  254. package/skills/motion-ui/SKILL.md +576 -576
  255. package/skills/mysql-patterns/SKILL.md +413 -413
  256. package/skills/nanoclaw-repl/SKILL.md +34 -34
  257. package/skills/nestjs-patterns/SKILL.md +231 -231
  258. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  259. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  260. package/skills/network-config-validation/SKILL.md +211 -211
  261. package/skills/network-interface-health/SKILL.md +153 -153
  262. package/skills/nextjs-turbopack/SKILL.md +58 -58
  263. package/skills/nodejs-keccak256/SKILL.md +103 -103
  264. package/skills/nutrient-document-processing/SKILL.md +168 -168
  265. package/skills/nuxt4-patterns/SKILL.md +101 -101
  266. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  267. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  268. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  269. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  270. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  271. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  272. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  273. package/skills/opensource-pipeline/SKILL.md +256 -256
  274. package/skills/orch-add-feature/SKILL.md +45 -45
  275. package/skills/orch-build-mvp/SKILL.md +49 -49
  276. package/skills/orch-change-feature/SKILL.md +43 -43
  277. package/skills/orch-fix-defect/SKILL.md +43 -43
  278. package/skills/orch-pipeline/SKILL.md +121 -121
  279. package/skills/orch-refine-code/SKILL.md +44 -44
  280. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  281. package/skills/perl-patterns/SKILL.md +505 -505
  282. package/skills/perl-security/SKILL.md +504 -504
  283. package/skills/perl-testing/SKILL.md +476 -476
  284. package/skills/plan-canvas/SKILL.md +153 -153
  285. package/skills/plan-orchestrate/SKILL.md +263 -263
  286. package/skills/plankton-code-quality/SKILL.md +237 -237
  287. package/skills/postgres-patterns/SKILL.md +148 -148
  288. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  289. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  290. package/skills/premium-web-design/SKILL.md +154 -154
  291. package/skills/prisma-patterns/SKILL.md +401 -401
  292. package/skills/product-capability/SKILL.md +142 -142
  293. package/skills/product-lens/SKILL.md +93 -93
  294. package/skills/production-audit/SKILL.md +207 -207
  295. package/skills/production-scheduling/SKILL.md +238 -238
  296. package/skills/project-flow-ops/SKILL.md +112 -112
  297. package/skills/prompt-optimizer/SKILL.md +398 -398
  298. package/skills/python-patterns/SKILL.md +751 -751
  299. package/skills/python-testing/SKILL.md +817 -817
  300. package/skills/pytorch-patterns/SKILL.md +397 -397
  301. package/skills/quality-nonconformance/SKILL.md +260 -260
  302. package/skills/quarkus-patterns/SKILL.md +723 -723
  303. package/skills/quarkus-security/SKILL.md +468 -468
  304. package/skills/quarkus-tdd/SKILL.md +812 -812
  305. package/skills/quarkus-verification/SKILL.md +480 -480
  306. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  307. package/skills/react-native-patterns/SKILL.md +326 -326
  308. package/skills/react-patterns/SKILL.md +342 -342
  309. package/skills/react-performance/SKILL.md +575 -575
  310. package/skills/react-testing/SKILL.md +424 -424
  311. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  312. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  313. package/skills/redis-patterns/SKILL.md +404 -404
  314. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  315. package/skills/remotion-video-creation/SKILL.md +43 -43
  316. package/skills/repo-scan/SKILL.md +79 -79
  317. package/skills/research-ops/SKILL.md +113 -113
  318. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  319. package/skills/rules-distill/SKILL.md +265 -265
  320. package/skills/rust-patterns/SKILL.md +500 -500
  321. package/skills/rust-testing/SKILL.md +501 -501
  322. package/skills/safety-guard/SKILL.md +76 -76
  323. package/skills/santa-method/SKILL.md +307 -307
  324. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  325. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  326. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  327. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  328. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  329. package/skills/search-first/SKILL.md +183 -183
  330. package/skills/security-bounty-hunter/SKILL.md +100 -100
  331. package/skills/security-review/SKILL.md +504 -504
  332. package/skills/security-scan/SKILL.md +166 -166
  333. package/skills/seo/SKILL.md +155 -155
  334. package/skills/skill-comply/SKILL.md +59 -59
  335. package/skills/skill-scout/SKILL.md +141 -141
  336. package/skills/skill-stocktake/SKILL.md +195 -195
  337. package/skills/social-graph-ranker/SKILL.md +155 -155
  338. package/skills/social-publisher/SKILL.md +130 -130
  339. package/skills/springboot-patterns/SKILL.md +315 -315
  340. package/skills/springboot-security/SKILL.md +273 -273
  341. package/skills/springboot-tdd/SKILL.md +159 -159
  342. package/skills/springboot-verification/SKILL.md +232 -232
  343. package/skills/strategic-compact/SKILL.md +142 -142
  344. package/skills/swift-actor-persistence/SKILL.md +144 -144
  345. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  346. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  347. package/skills/swiftui-patterns/SKILL.md +259 -259
  348. package/skills/taste/SKILL.md +264 -264
  349. package/skills/taste/references/genre-taxonomy.md +87 -87
  350. package/skills/tdd-workflow/SKILL.md +583 -583
  351. package/skills/team-agent-orchestration/SKILL.md +111 -111
  352. package/skills/team-builder/SKILL.md +169 -169
  353. package/skills/terminal-ops/SKILL.md +110 -110
  354. package/skills/tinystruct-patterns/SKILL.md +279 -279
  355. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  356. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  357. package/skills/tinystruct-patterns/references/database.md +99 -99
  358. package/skills/tinystruct-patterns/references/routing.md +64 -64
  359. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  360. package/skills/tinystruct-patterns/references/testing.md +72 -72
  361. package/skills/token-budget-advisor/SKILL.md +134 -134
  362. package/skills/ui-demo/SKILL.md +466 -466
  363. package/skills/ui-to-vue/SKILL.md +135 -135
  364. package/skills/uncloud/SKILL.md +344 -344
  365. package/skills/unified-memory/SKILL.md +170 -170
  366. package/skills/unified-notifications-ops/SKILL.md +188 -188
  367. package/skills/verification-loop/SKILL.md +129 -129
  368. package/skills/video-editing/SKILL.md +311 -311
  369. package/skills/videodb/SKILL.md +375 -375
  370. package/skills/visa-doc-translate/SKILL.md +117 -117
  371. package/skills/vite-patterns/SKILL.md +450 -450
  372. package/skills/vue-patterns/SKILL.md +471 -471
  373. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  374. package/skills/workspace-surface-audit/SKILL.md +126 -126
  375. package/skills/x-api/SKILL.md +235 -235
@@ -1,735 +1,735 @@
1
- ---
2
- name: django-patterns
3
- description: Django architecture patterns, REST API design with DRF, ORM best practices, caching, signals, middleware, and production-grade Django apps.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Django Development Patterns
9
-
10
- Production-grade Django architecture patterns for scalable, maintainable applications.
11
-
12
- ## When to Activate
13
-
14
- - Building Django web applications
15
- - Designing Django REST Framework APIs
16
- - Working with Django ORM and models
17
- - Setting up Django project structure
18
- - Implementing caching, signals, middleware
19
-
20
- ## Project Structure
21
-
22
- ### Recommended Layout
23
-
24
- ```
25
- myproject/
26
- ├── config/
27
- │ ├── __init__.py
28
- │ ├── settings/
29
- │ │ ├── __init__.py
30
- │ │ ├── base.py # Base settings
31
- │ │ ├── development.py # Dev settings
32
- │ │ ├── production.py # Production settings
33
- │ │ └── test.py # Test settings
34
- │ ├── urls.py
35
- │ ├── wsgi.py
36
- │ └── asgi.py
37
- ├── manage.py
38
- └── apps/
39
- ├── __init__.py
40
- ├── users/
41
- │ ├── __init__.py
42
- │ ├── models.py
43
- │ ├── views.py
44
- │ ├── serializers.py
45
- │ ├── urls.py
46
- │ ├── permissions.py
47
- │ ├── filters.py
48
- │ ├── services.py
49
- │ └── tests/
50
- └── products/
51
- └── ...
52
- ```
53
-
54
- ### Split Settings Pattern
55
-
56
- ```python
57
- # config/settings/base.py
58
- from pathlib import Path
59
-
60
- BASE_DIR = Path(__file__).resolve().parent.parent.parent
61
-
62
- SECRET_KEY = env('DJANGO_SECRET_KEY')
63
- DEBUG = False
64
- ALLOWED_HOSTS = []
65
-
66
- INSTALLED_APPS = [
67
- 'django.contrib.admin',
68
- 'django.contrib.auth',
69
- 'django.contrib.contenttypes',
70
- 'django.contrib.sessions',
71
- 'django.contrib.messages',
72
- 'django.contrib.staticfiles',
73
- 'rest_framework',
74
- 'rest_framework.authtoken',
75
- 'corsheaders',
76
- # Local apps
77
- 'apps.users',
78
- 'apps.products',
79
- ]
80
-
81
- MIDDLEWARE = [
82
- 'django.middleware.security.SecurityMiddleware',
83
- 'whitenoise.middleware.WhiteNoiseMiddleware',
84
- 'django.contrib.sessions.middleware.SessionMiddleware',
85
- 'corsheaders.middleware.CorsMiddleware',
86
- 'django.middleware.common.CommonMiddleware',
87
- 'django.middleware.csrf.CsrfViewMiddleware',
88
- 'django.contrib.auth.middleware.AuthenticationMiddleware',
89
- 'django.contrib.messages.middleware.MessageMiddleware',
90
- 'django.middleware.clickjacking.XFrameOptionsMiddleware',
91
- ]
92
-
93
- ROOT_URLCONF = 'config.urls'
94
- WSGI_APPLICATION = 'config.wsgi.application'
95
-
96
- DATABASES = {
97
- 'default': {
98
- 'ENGINE': 'django.db.backends.postgresql',
99
- 'NAME': env('DB_NAME'),
100
- 'USER': env('DB_USER'),
101
- 'PASSWORD': env('DB_PASSWORD'),
102
- 'HOST': env('DB_HOST'),
103
- 'PORT': env('DB_PORT', default='5432'),
104
- }
105
- }
106
-
107
- # config/settings/development.py
108
- from .base import *
109
-
110
- DEBUG = True
111
- ALLOWED_HOSTS = ['localhost', '127.0.0.1']
112
-
113
- DATABASES['default']['NAME'] = 'myproject_dev'
114
-
115
- INSTALLED_APPS += ['debug_toolbar']
116
-
117
- MIDDLEWARE += ['debug_toolbar.middleware.DebugToolbarMiddleware']
118
-
119
- EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
120
-
121
- # config/settings/production.py
122
- from .base import *
123
-
124
- DEBUG = False
125
- ALLOWED_HOSTS = env.list('ALLOWED_HOSTS')
126
- SECURE_SSL_REDIRECT = True
127
- SESSION_COOKIE_SECURE = True
128
- CSRF_COOKIE_SECURE = True
129
- SECURE_HSTS_SECONDS = 31536000
130
- SECURE_HSTS_INCLUDE_SUBDOMAINS = True
131
- SECURE_HSTS_PRELOAD = True
132
-
133
- # Logging
134
- LOGGING = {
135
- 'version': 1,
136
- 'disable_existing_loggers': False,
137
- 'handlers': {
138
- 'file': {
139
- 'level': 'WARNING',
140
- 'class': 'logging.FileHandler',
141
- 'filename': '/var/log/django/django.log',
142
- },
143
- },
144
- 'loggers': {
145
- 'django': {
146
- 'handlers': ['file'],
147
- 'level': 'WARNING',
148
- 'propagate': True,
149
- },
150
- },
151
- }
152
- ```
153
-
154
- ## Model Design Patterns
155
-
156
- ### Model Best Practices
157
-
158
- ```python
159
- from django.db import models
160
- from django.contrib.auth.models import AbstractUser
161
- from django.core.validators import MinValueValidator, MaxValueValidator
162
-
163
- class User(AbstractUser):
164
- """Custom user model extending AbstractUser."""
165
- email = models.EmailField(unique=True)
166
- phone = models.CharField(max_length=20, blank=True)
167
- birth_date = models.DateField(null=True, blank=True)
168
-
169
- USERNAME_FIELD = 'email'
170
- REQUIRED_FIELDS = ['username']
171
-
172
- class Meta:
173
- db_table = 'users'
174
- verbose_name = 'user'
175
- verbose_name_plural = 'users'
176
- ordering = ['-date_joined']
177
-
178
- def __str__(self):
179
- return self.email
180
-
181
- def get_full_name(self):
182
- return f"{self.first_name} {self.last_name}".strip()
183
-
184
- class Product(models.Model):
185
- """Product model with proper field configuration."""
186
- name = models.CharField(max_length=200)
187
- slug = models.SlugField(unique=True, max_length=250)
188
- description = models.TextField(blank=True)
189
- price = models.DecimalField(
190
- max_digits=10,
191
- decimal_places=2,
192
- validators=[MinValueValidator(0)]
193
- )
194
- stock = models.PositiveIntegerField(default=0)
195
- is_active = models.BooleanField(default=True)
196
- category = models.ForeignKey(
197
- 'Category',
198
- on_delete=models.CASCADE,
199
- related_name='products'
200
- )
201
- tags = models.ManyToManyField('Tag', blank=True, related_name='products')
202
- created_at = models.DateTimeField(auto_now_add=True)
203
- updated_at = models.DateTimeField(auto_now=True)
204
-
205
- class Meta:
206
- db_table = 'products'
207
- ordering = ['-created_at']
208
- indexes = [
209
- models.Index(fields=['slug']),
210
- models.Index(fields=['-created_at']),
211
- models.Index(fields=['category', 'is_active']),
212
- ]
213
- constraints = [
214
- models.CheckConstraint(
215
- check=models.Q(price__gte=0),
216
- name='price_non_negative'
217
- )
218
- ]
219
-
220
- def __str__(self):
221
- return self.name
222
-
223
- def save(self, *args, **kwargs):
224
- if not self.slug:
225
- self.slug = slugify(self.name)
226
- super().save(*args, **kwargs)
227
- ```
228
-
229
- ### QuerySet Best Practices
230
-
231
- ```python
232
- from django.db import models
233
-
234
- class ProductQuerySet(models.QuerySet):
235
- """Custom QuerySet for Product model."""
236
-
237
- def active(self):
238
- """Return only active products."""
239
- return self.filter(is_active=True)
240
-
241
- def with_category(self):
242
- """Select related category to avoid N+1 queries."""
243
- return self.select_related('category')
244
-
245
- def with_tags(self):
246
- """Prefetch tags for many-to-many relationship."""
247
- return self.prefetch_related('tags')
248
-
249
- def in_stock(self):
250
- """Return products with stock > 0."""
251
- return self.filter(stock__gt=0)
252
-
253
- def search(self, query):
254
- """Search products by name or description."""
255
- return self.filter(
256
- models.Q(name__icontains=query) |
257
- models.Q(description__icontains=query)
258
- )
259
-
260
- class Product(models.Model):
261
- # ... fields ...
262
-
263
- objects = ProductQuerySet.as_manager() # Use custom QuerySet
264
-
265
- # Usage
266
- Product.objects.active().with_category().in_stock()
267
- ```
268
-
269
- ### Manager Methods
270
-
271
- ```python
272
- class ProductManager(models.Manager):
273
- """Custom manager for complex queries."""
274
-
275
- def get_or_none(self, **kwargs):
276
- """Return object or None instead of DoesNotExist."""
277
- try:
278
- return self.get(**kwargs)
279
- except self.model.DoesNotExist:
280
- return None
281
-
282
- def create_with_tags(self, name, price, tag_names):
283
- """Create product with associated tags."""
284
- product = self.create(name=name, price=price)
285
- tags = [Tag.objects.get_or_create(name=name)[0] for name in tag_names]
286
- product.tags.set(tags)
287
- return product
288
-
289
- def bulk_update_stock(self, product_ids, quantity):
290
- """Bulk update stock for multiple products."""
291
- return self.filter(id__in=product_ids).update(stock=quantity)
292
-
293
- # In model
294
- class Product(models.Model):
295
- # ... fields ...
296
- custom = ProductManager()
297
- ```
298
-
299
- ## Django REST Framework Patterns
300
-
301
- ### Serializer Patterns
302
-
303
- ```python
304
- from rest_framework import serializers
305
- from django.contrib.auth.password_validation import validate_password
306
- from .models import Product, User
307
-
308
- class ProductSerializer(serializers.ModelSerializer):
309
- """Serializer for Product model."""
310
-
311
- category_name = serializers.CharField(source='category.name', read_only=True)
312
- average_rating = serializers.FloatField(read_only=True)
313
- discount_price = serializers.SerializerMethodField()
314
-
315
- class Meta:
316
- model = Product
317
- fields = [
318
- 'id', 'name', 'slug', 'description', 'price',
319
- 'discount_price', 'stock', 'category_name',
320
- 'average_rating', 'created_at'
321
- ]
322
- read_only_fields = ['id', 'slug', 'created_at']
323
-
324
- def get_discount_price(self, obj):
325
- """Calculate discount price if applicable."""
326
- if hasattr(obj, 'discount') and obj.discount:
327
- return obj.price * (1 - obj.discount.percent / 100)
328
- return obj.price
329
-
330
- def validate_price(self, value):
331
- """Ensure price is non-negative."""
332
- if value < 0:
333
- raise serializers.ValidationError("Price cannot be negative.")
334
- return value
335
-
336
- class ProductCreateSerializer(serializers.ModelSerializer):
337
- """Serializer for creating products."""
338
-
339
- class Meta:
340
- model = Product
341
- fields = ['name', 'description', 'price', 'stock', 'category']
342
-
343
- def validate(self, data):
344
- """Custom validation for multiple fields."""
345
- if data['price'] > 10000 and data['stock'] > 100:
346
- raise serializers.ValidationError(
347
- "Cannot have high-value products with large stock."
348
- )
349
- return data
350
-
351
- class UserRegistrationSerializer(serializers.ModelSerializer):
352
- """Serializer for user registration."""
353
-
354
- password = serializers.CharField(
355
- write_only=True,
356
- required=True,
357
- validators=[validate_password],
358
- style={'input_type': 'password'}
359
- )
360
- password_confirm = serializers.CharField(write_only=True, style={'input_type': 'password'})
361
-
362
- class Meta:
363
- model = User
364
- fields = ['email', 'username', 'password', 'password_confirm']
365
-
366
- def validate(self, data):
367
- """Validate passwords match."""
368
- if data['password'] != data['password_confirm']:
369
- raise serializers.ValidationError({
370
- "password_confirm": "Password fields didn't match."
371
- })
372
- return data
373
-
374
- def create(self, validated_data):
375
- """Create user with hashed password."""
376
- validated_data.pop('password_confirm')
377
- password = validated_data.pop('password')
378
- user = User.objects.create(**validated_data)
379
- user.set_password(password)
380
- user.save()
381
- return user
382
- ```
383
-
384
- ### ViewSet Patterns
385
-
386
- ```python
387
- from rest_framework import viewsets, status, filters
388
- from rest_framework.decorators import action
389
- from rest_framework.response import Response
390
- from rest_framework.permissions import IsAuthenticated, IsAdminUser
391
- from django_filters.rest_framework import DjangoFilterBackend
392
- from .models import Product
393
- from .serializers import ProductSerializer, ProductCreateSerializer
394
- from .permissions import IsOwnerOrReadOnly
395
- from .filters import ProductFilter
396
- from .services import ProductService
397
-
398
- class ProductViewSet(viewsets.ModelViewSet):
399
- """ViewSet for Product model."""
400
-
401
- queryset = Product.objects.select_related('category').prefetch_related('tags')
402
- permission_classes = [IsAuthenticated, IsOwnerOrReadOnly]
403
- filter_backends = [DjangoFilterBackend, filters.SearchFilter, filters.OrderingFilter]
404
- filterset_class = ProductFilter
405
- search_fields = ['name', 'description']
406
- ordering_fields = ['price', 'created_at', 'name']
407
- ordering = ['-created_at']
408
-
409
- def get_serializer_class(self):
410
- """Return appropriate serializer based on action."""
411
- if self.action == 'create':
412
- return ProductCreateSerializer
413
- return ProductSerializer
414
-
415
- def perform_create(self, serializer):
416
- """Save with user context."""
417
- serializer.save(created_by=self.request.user)
418
-
419
- @action(detail=False, methods=['get'])
420
- def featured(self, request):
421
- """Return featured products."""
422
- featured = self.queryset.filter(is_featured=True)[:10]
423
- serializer = self.get_serializer(featured, many=True)
424
- return Response(serializer.data)
425
-
426
- @action(detail=True, methods=['post'])
427
- def purchase(self, request, pk=None):
428
- """Purchase a product."""
429
- product = self.get_object()
430
- service = ProductService()
431
- result = service.purchase(product, request.user)
432
- return Response(result, status=status.HTTP_201_CREATED)
433
-
434
- @action(detail=False, methods=['get'], permission_classes=[IsAuthenticated])
435
- def my_products(self, request):
436
- """Return products created by current user."""
437
- products = self.queryset.filter(created_by=request.user)
438
- page = self.paginate_queryset(products)
439
- serializer = self.get_serializer(page, many=True)
440
- return self.get_paginated_response(serializer.data)
441
- ```
442
-
443
- ### Custom Actions
444
-
445
- ```python
446
- from rest_framework.decorators import api_view, permission_classes
447
- from rest_framework.permissions import IsAuthenticated
448
- from rest_framework.response import Response
449
-
450
- @api_view(['POST'])
451
- @permission_classes([IsAuthenticated])
452
- def add_to_cart(request):
453
- """Add product to user cart."""
454
- product_id = request.data.get('product_id')
455
- quantity = request.data.get('quantity', 1)
456
-
457
- try:
458
- product = Product.objects.get(id=product_id)
459
- except Product.DoesNotExist:
460
- return Response(
461
- {'error': 'Product not found'},
462
- status=status.HTTP_404_NOT_FOUND
463
- )
464
-
465
- cart, _ = Cart.objects.get_or_create(user=request.user)
466
- CartItem.objects.create(
467
- cart=cart,
468
- product=product,
469
- quantity=quantity
470
- )
471
-
472
- return Response({'message': 'Added to cart'}, status=status.HTTP_201_CREATED)
473
- ```
474
-
475
- ## Service Layer Pattern
476
-
477
- ```python
478
- # apps/orders/services.py
479
- from typing import Optional
480
- from django.db import transaction
481
- from .models import Order, OrderItem
482
-
483
- class OrderService:
484
- """Service layer for order-related business logic."""
485
-
486
- @staticmethod
487
- @transaction.atomic
488
- def create_order(user, cart: Cart) -> Order:
489
- """Create order from cart."""
490
- order = Order.objects.create(
491
- user=user,
492
- total_price=cart.total_price
493
- )
494
-
495
- for item in cart.items.all():
496
- OrderItem.objects.create(
497
- order=order,
498
- product=item.product,
499
- quantity=item.quantity,
500
- price=item.product.price
501
- )
502
-
503
- # Clear cart
504
- cart.items.all().delete()
505
-
506
- return order
507
-
508
- @staticmethod
509
- def process_payment(order: Order, payment_data: dict) -> bool:
510
- """Process payment for order."""
511
- # Integration with payment gateway
512
- payment = PaymentGateway.charge(
513
- amount=order.total_price,
514
- token=payment_data['token']
515
- )
516
-
517
- if payment.success:
518
- order.status = Order.Status.PAID
519
- order.save()
520
- # Send confirmation email
521
- OrderService.send_confirmation_email(order)
522
- return True
523
-
524
- return False
525
-
526
- @staticmethod
527
- def send_confirmation_email(order: Order):
528
- """Send order confirmation email."""
529
- # Email sending logic
530
- pass
531
- ```
532
-
533
- ## Caching Strategies
534
-
535
- ### View-Level Caching
536
-
537
- ```python
538
- from django.views.decorators.cache import cache_page
539
- from django.utils.decorators import method_decorator
540
-
541
- @method_decorator(cache_page(60 * 15), name='dispatch') # 15 minutes
542
- class ProductListView(generic.ListView):
543
- model = Product
544
- template_name = 'products/list.html'
545
- context_object_name = 'products'
546
- ```
547
-
548
- ### Template Fragment Caching
549
-
550
- ```django
551
- {% load cache %}
552
- {% cache 500 sidebar %}
553
- ... expensive sidebar content ...
554
- {% endcache %}
555
- ```
556
-
557
- ### Low-Level Caching
558
-
559
- ```python
560
- from django.core.cache import cache
561
-
562
- def get_featured_products():
563
- """Get featured products with caching."""
564
- cache_key = 'featured_products'
565
- products = cache.get(cache_key)
566
-
567
- if products is None:
568
- products = list(Product.objects.filter(is_featured=True))
569
- cache.set(cache_key, products, timeout=60 * 15) # 15 minutes
570
-
571
- return products
572
- ```
573
-
574
- ### QuerySet Caching
575
-
576
- ```python
577
- from django.core.cache import cache
578
-
579
- def get_popular_categories():
580
- cache_key = 'popular_categories'
581
- categories = cache.get(cache_key)
582
-
583
- if categories is None:
584
- categories = list(Category.objects.annotate(
585
- product_count=Count('products')
586
- ).filter(product_count__gt=10).order_by('-product_count')[:20])
587
- cache.set(cache_key, categories, timeout=60 * 60) # 1 hour
588
-
589
- return categories
590
- ```
591
-
592
- ## Signals
593
-
594
- ### Signal Patterns
595
-
596
- ```python
597
- # apps/users/signals.py
598
- from django.db.models.signals import post_save
599
- from django.dispatch import receiver
600
- from django.contrib.auth import get_user_model
601
- from .models import Profile
602
-
603
- User = get_user_model()
604
-
605
- @receiver(post_save, sender=User)
606
- def create_user_profile(sender, instance, created, **kwargs):
607
- """Create profile when user is created."""
608
- if created:
609
- Profile.objects.create(user=instance)
610
-
611
- @receiver(post_save, sender=User)
612
- def save_user_profile(sender, instance, **kwargs):
613
- """Save profile when user is saved."""
614
- instance.profile.save()
615
-
616
- # apps/users/apps.py
617
- from django.apps import AppConfig
618
-
619
- class UsersConfig(AppConfig):
620
- default_auto_field = 'django.db.models.BigAutoField'
621
- name = 'apps.users'
622
-
623
- def ready(self):
624
- """Import signals when app is ready."""
625
- import apps.users.signals
626
- ```
627
-
628
- ## Middleware
629
-
630
- ### Custom Middleware
631
-
632
- ```python
633
- # middleware/active_user_middleware.py
634
- import time
635
- from django.utils.deprecation import MiddlewareMixin
636
-
637
- class ActiveUserMiddleware(MiddlewareMixin):
638
- """Middleware to track active users."""
639
-
640
- def process_request(self, request):
641
- """Process incoming request."""
642
- if request.user.is_authenticated:
643
- # Update last active time
644
- request.user.last_active = timezone.now()
645
- request.user.save(update_fields=['last_active'])
646
-
647
- class RequestLoggingMiddleware(MiddlewareMixin):
648
- """Middleware for logging requests."""
649
-
650
- def process_request(self, request):
651
- """Log request start time."""
652
- request.start_time = time.time()
653
-
654
- def process_response(self, request, response):
655
- """Log request duration."""
656
- if hasattr(request, 'start_time'):
657
- duration = time.time() - request.start_time
658
- logger.info(f'{request.method} {request.path} - {response.status_code} - {duration:.3f}s')
659
- return response
660
- ```
661
-
662
- ## Performance Optimization
663
-
664
- ### N+1 Query Prevention
665
-
666
- ```python
667
- # Bad - N+1 queries
668
- products = Product.objects.all()
669
- for product in products:
670
- print(product.category.name) # Separate query for each product
671
-
672
- # Good - Single query with select_related
673
- products = Product.objects.select_related('category').all()
674
- for product in products:
675
- print(product.category.name)
676
-
677
- # Good - Prefetch for many-to-many
678
- products = Product.objects.prefetch_related('tags').all()
679
- for product in products:
680
- for tag in product.tags.all():
681
- print(tag.name)
682
- ```
683
-
684
- ### Database Indexing
685
-
686
- ```python
687
- class Product(models.Model):
688
- name = models.CharField(max_length=200, db_index=True)
689
- slug = models.SlugField(unique=True)
690
- category = models.ForeignKey('Category', on_delete=models.CASCADE)
691
- created_at = models.DateTimeField(auto_now_add=True)
692
-
693
- class Meta:
694
- indexes = [
695
- models.Index(fields=['name']),
696
- models.Index(fields=['-created_at']),
697
- models.Index(fields=['category', 'created_at']),
698
- ]
699
- ```
700
-
701
- ### Bulk Operations
702
-
703
- ```python
704
- # Bulk create
705
- Product.objects.bulk_create([
706
- Product(name=f'Product {i}', price=10.00)
707
- for i in range(1000)
708
- ])
709
-
710
- # Bulk update
711
- products = Product.objects.all()[:100]
712
- for product in products:
713
- product.is_active = True
714
- Product.objects.bulk_update(products, ['is_active'])
715
-
716
- # Bulk delete
717
- Product.objects.filter(stock=0).delete()
718
- ```
719
-
720
- ## Quick Reference
721
-
722
- | Pattern | Description |
723
- |---------|-------------|
724
- | Split settings | Separate dev/prod/test settings |
725
- | Custom QuerySet | Reusable query methods |
726
- | Service Layer | Business logic separation |
727
- | ViewSet | REST API endpoints |
728
- | Serializer validation | Request/response transformation |
729
- | select_related | Foreign key optimization |
730
- | prefetch_related | Many-to-many optimization |
731
- | Cache first | Cache expensive operations |
732
- | Signals | Event-driven actions |
733
- | Middleware | Request/response processing |
734
-
735
- Remember: Django provides many shortcuts, but for production applications, structure and organization matter more than concise code. Build for maintainability.
1
+ ---
2
+ name: django-patterns
3
+ description: Django architecture patterns, REST API design with DRF, ORM best practices, caching, signals, middleware, and production-grade Django apps.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Django Development Patterns
9
+
10
+ Production-grade Django architecture patterns for scalable, maintainable applications.
11
+
12
+ ## When to Activate
13
+
14
+ - Building Django web applications
15
+ - Designing Django REST Framework APIs
16
+ - Working with Django ORM and models
17
+ - Setting up Django project structure
18
+ - Implementing caching, signals, middleware
19
+
20
+ ## Project Structure
21
+
22
+ ### Recommended Layout
23
+
24
+ ```
25
+ myproject/
26
+ ├── config/
27
+ │ ├── __init__.py
28
+ │ ├── settings/
29
+ │ │ ├── __init__.py
30
+ │ │ ├── base.py # Base settings
31
+ │ │ ├── development.py # Dev settings
32
+ │ │ ├── production.py # Production settings
33
+ │ │ └── test.py # Test settings
34
+ │ ├── urls.py
35
+ │ ├── wsgi.py
36
+ │ └── asgi.py
37
+ ├── manage.py
38
+ └── apps/
39
+ ├── __init__.py
40
+ ├── users/
41
+ │ ├── __init__.py
42
+ │ ├── models.py
43
+ │ ├── views.py
44
+ │ ├── serializers.py
45
+ │ ├── urls.py
46
+ │ ├── permissions.py
47
+ │ ├── filters.py
48
+ │ ├── services.py
49
+ │ └── tests/
50
+ └── products/
51
+ └── ...
52
+ ```
53
+
54
+ ### Split Settings Pattern
55
+
56
+ ```python
57
+ # config/settings/base.py
58
+ from pathlib import Path
59
+
60
+ BASE_DIR = Path(__file__).resolve().parent.parent.parent
61
+
62
+ SECRET_KEY = env('DJANGO_SECRET_KEY')
63
+ DEBUG = False
64
+ ALLOWED_HOSTS = []
65
+
66
+ INSTALLED_APPS = [
67
+ 'django.contrib.admin',
68
+ 'django.contrib.auth',
69
+ 'django.contrib.contenttypes',
70
+ 'django.contrib.sessions',
71
+ 'django.contrib.messages',
72
+ 'django.contrib.staticfiles',
73
+ 'rest_framework',
74
+ 'rest_framework.authtoken',
75
+ 'corsheaders',
76
+ # Local apps
77
+ 'apps.users',
78
+ 'apps.products',
79
+ ]
80
+
81
+ MIDDLEWARE = [
82
+ 'django.middleware.security.SecurityMiddleware',
83
+ 'whitenoise.middleware.WhiteNoiseMiddleware',
84
+ 'django.contrib.sessions.middleware.SessionMiddleware',
85
+ 'corsheaders.middleware.CorsMiddleware',
86
+ 'django.middleware.common.CommonMiddleware',
87
+ 'django.middleware.csrf.CsrfViewMiddleware',
88
+ 'django.contrib.auth.middleware.AuthenticationMiddleware',
89
+ 'django.contrib.messages.middleware.MessageMiddleware',
90
+ 'django.middleware.clickjacking.XFrameOptionsMiddleware',
91
+ ]
92
+
93
+ ROOT_URLCONF = 'config.urls'
94
+ WSGI_APPLICATION = 'config.wsgi.application'
95
+
96
+ DATABASES = {
97
+ 'default': {
98
+ 'ENGINE': 'django.db.backends.postgresql',
99
+ 'NAME': env('DB_NAME'),
100
+ 'USER': env('DB_USER'),
101
+ 'PASSWORD': env('DB_PASSWORD'),
102
+ 'HOST': env('DB_HOST'),
103
+ 'PORT': env('DB_PORT', default='5432'),
104
+ }
105
+ }
106
+
107
+ # config/settings/development.py
108
+ from .base import *
109
+
110
+ DEBUG = True
111
+ ALLOWED_HOSTS = ['localhost', '127.0.0.1']
112
+
113
+ DATABASES['default']['NAME'] = 'myproject_dev'
114
+
115
+ INSTALLED_APPS += ['debug_toolbar']
116
+
117
+ MIDDLEWARE += ['debug_toolbar.middleware.DebugToolbarMiddleware']
118
+
119
+ EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
120
+
121
+ # config/settings/production.py
122
+ from .base import *
123
+
124
+ DEBUG = False
125
+ ALLOWED_HOSTS = env.list('ALLOWED_HOSTS')
126
+ SECURE_SSL_REDIRECT = True
127
+ SESSION_COOKIE_SECURE = True
128
+ CSRF_COOKIE_SECURE = True
129
+ SECURE_HSTS_SECONDS = 31536000
130
+ SECURE_HSTS_INCLUDE_SUBDOMAINS = True
131
+ SECURE_HSTS_PRELOAD = True
132
+
133
+ # Logging
134
+ LOGGING = {
135
+ 'version': 1,
136
+ 'disable_existing_loggers': False,
137
+ 'handlers': {
138
+ 'file': {
139
+ 'level': 'WARNING',
140
+ 'class': 'logging.FileHandler',
141
+ 'filename': '/var/log/django/django.log',
142
+ },
143
+ },
144
+ 'loggers': {
145
+ 'django': {
146
+ 'handlers': ['file'],
147
+ 'level': 'WARNING',
148
+ 'propagate': True,
149
+ },
150
+ },
151
+ }
152
+ ```
153
+
154
+ ## Model Design Patterns
155
+
156
+ ### Model Best Practices
157
+
158
+ ```python
159
+ from django.db import models
160
+ from django.contrib.auth.models import AbstractUser
161
+ from django.core.validators import MinValueValidator, MaxValueValidator
162
+
163
+ class User(AbstractUser):
164
+ """Custom user model extending AbstractUser."""
165
+ email = models.EmailField(unique=True)
166
+ phone = models.CharField(max_length=20, blank=True)
167
+ birth_date = models.DateField(null=True, blank=True)
168
+
169
+ USERNAME_FIELD = 'email'
170
+ REQUIRED_FIELDS = ['username']
171
+
172
+ class Meta:
173
+ db_table = 'users'
174
+ verbose_name = 'user'
175
+ verbose_name_plural = 'users'
176
+ ordering = ['-date_joined']
177
+
178
+ def __str__(self):
179
+ return self.email
180
+
181
+ def get_full_name(self):
182
+ return f"{self.first_name} {self.last_name}".strip()
183
+
184
+ class Product(models.Model):
185
+ """Product model with proper field configuration."""
186
+ name = models.CharField(max_length=200)
187
+ slug = models.SlugField(unique=True, max_length=250)
188
+ description = models.TextField(blank=True)
189
+ price = models.DecimalField(
190
+ max_digits=10,
191
+ decimal_places=2,
192
+ validators=[MinValueValidator(0)]
193
+ )
194
+ stock = models.PositiveIntegerField(default=0)
195
+ is_active = models.BooleanField(default=True)
196
+ category = models.ForeignKey(
197
+ 'Category',
198
+ on_delete=models.CASCADE,
199
+ related_name='products'
200
+ )
201
+ tags = models.ManyToManyField('Tag', blank=True, related_name='products')
202
+ created_at = models.DateTimeField(auto_now_add=True)
203
+ updated_at = models.DateTimeField(auto_now=True)
204
+
205
+ class Meta:
206
+ db_table = 'products'
207
+ ordering = ['-created_at']
208
+ indexes = [
209
+ models.Index(fields=['slug']),
210
+ models.Index(fields=['-created_at']),
211
+ models.Index(fields=['category', 'is_active']),
212
+ ]
213
+ constraints = [
214
+ models.CheckConstraint(
215
+ check=models.Q(price__gte=0),
216
+ name='price_non_negative'
217
+ )
218
+ ]
219
+
220
+ def __str__(self):
221
+ return self.name
222
+
223
+ def save(self, *args, **kwargs):
224
+ if not self.slug:
225
+ self.slug = slugify(self.name)
226
+ super().save(*args, **kwargs)
227
+ ```
228
+
229
+ ### QuerySet Best Practices
230
+
231
+ ```python
232
+ from django.db import models
233
+
234
+ class ProductQuerySet(models.QuerySet):
235
+ """Custom QuerySet for Product model."""
236
+
237
+ def active(self):
238
+ """Return only active products."""
239
+ return self.filter(is_active=True)
240
+
241
+ def with_category(self):
242
+ """Select related category to avoid N+1 queries."""
243
+ return self.select_related('category')
244
+
245
+ def with_tags(self):
246
+ """Prefetch tags for many-to-many relationship."""
247
+ return self.prefetch_related('tags')
248
+
249
+ def in_stock(self):
250
+ """Return products with stock > 0."""
251
+ return self.filter(stock__gt=0)
252
+
253
+ def search(self, query):
254
+ """Search products by name or description."""
255
+ return self.filter(
256
+ models.Q(name__icontains=query) |
257
+ models.Q(description__icontains=query)
258
+ )
259
+
260
+ class Product(models.Model):
261
+ # ... fields ...
262
+
263
+ objects = ProductQuerySet.as_manager() # Use custom QuerySet
264
+
265
+ # Usage
266
+ Product.objects.active().with_category().in_stock()
267
+ ```
268
+
269
+ ### Manager Methods
270
+
271
+ ```python
272
+ class ProductManager(models.Manager):
273
+ """Custom manager for complex queries."""
274
+
275
+ def get_or_none(self, **kwargs):
276
+ """Return object or None instead of DoesNotExist."""
277
+ try:
278
+ return self.get(**kwargs)
279
+ except self.model.DoesNotExist:
280
+ return None
281
+
282
+ def create_with_tags(self, name, price, tag_names):
283
+ """Create product with associated tags."""
284
+ product = self.create(name=name, price=price)
285
+ tags = [Tag.objects.get_or_create(name=name)[0] for name in tag_names]
286
+ product.tags.set(tags)
287
+ return product
288
+
289
+ def bulk_update_stock(self, product_ids, quantity):
290
+ """Bulk update stock for multiple products."""
291
+ return self.filter(id__in=product_ids).update(stock=quantity)
292
+
293
+ # In model
294
+ class Product(models.Model):
295
+ # ... fields ...
296
+ custom = ProductManager()
297
+ ```
298
+
299
+ ## Django REST Framework Patterns
300
+
301
+ ### Serializer Patterns
302
+
303
+ ```python
304
+ from rest_framework import serializers
305
+ from django.contrib.auth.password_validation import validate_password
306
+ from .models import Product, User
307
+
308
+ class ProductSerializer(serializers.ModelSerializer):
309
+ """Serializer for Product model."""
310
+
311
+ category_name = serializers.CharField(source='category.name', read_only=True)
312
+ average_rating = serializers.FloatField(read_only=True)
313
+ discount_price = serializers.SerializerMethodField()
314
+
315
+ class Meta:
316
+ model = Product
317
+ fields = [
318
+ 'id', 'name', 'slug', 'description', 'price',
319
+ 'discount_price', 'stock', 'category_name',
320
+ 'average_rating', 'created_at'
321
+ ]
322
+ read_only_fields = ['id', 'slug', 'created_at']
323
+
324
+ def get_discount_price(self, obj):
325
+ """Calculate discount price if applicable."""
326
+ if hasattr(obj, 'discount') and obj.discount:
327
+ return obj.price * (1 - obj.discount.percent / 100)
328
+ return obj.price
329
+
330
+ def validate_price(self, value):
331
+ """Ensure price is non-negative."""
332
+ if value < 0:
333
+ raise serializers.ValidationError("Price cannot be negative.")
334
+ return value
335
+
336
+ class ProductCreateSerializer(serializers.ModelSerializer):
337
+ """Serializer for creating products."""
338
+
339
+ class Meta:
340
+ model = Product
341
+ fields = ['name', 'description', 'price', 'stock', 'category']
342
+
343
+ def validate(self, data):
344
+ """Custom validation for multiple fields."""
345
+ if data['price'] > 10000 and data['stock'] > 100:
346
+ raise serializers.ValidationError(
347
+ "Cannot have high-value products with large stock."
348
+ )
349
+ return data
350
+
351
+ class UserRegistrationSerializer(serializers.ModelSerializer):
352
+ """Serializer for user registration."""
353
+
354
+ password = serializers.CharField(
355
+ write_only=True,
356
+ required=True,
357
+ validators=[validate_password],
358
+ style={'input_type': 'password'}
359
+ )
360
+ password_confirm = serializers.CharField(write_only=True, style={'input_type': 'password'})
361
+
362
+ class Meta:
363
+ model = User
364
+ fields = ['email', 'username', 'password', 'password_confirm']
365
+
366
+ def validate(self, data):
367
+ """Validate passwords match."""
368
+ if data['password'] != data['password_confirm']:
369
+ raise serializers.ValidationError({
370
+ "password_confirm": "Password fields didn't match."
371
+ })
372
+ return data
373
+
374
+ def create(self, validated_data):
375
+ """Create user with hashed password."""
376
+ validated_data.pop('password_confirm')
377
+ password = validated_data.pop('password')
378
+ user = User.objects.create(**validated_data)
379
+ user.set_password(password)
380
+ user.save()
381
+ return user
382
+ ```
383
+
384
+ ### ViewSet Patterns
385
+
386
+ ```python
387
+ from rest_framework import viewsets, status, filters
388
+ from rest_framework.decorators import action
389
+ from rest_framework.response import Response
390
+ from rest_framework.permissions import IsAuthenticated, IsAdminUser
391
+ from django_filters.rest_framework import DjangoFilterBackend
392
+ from .models import Product
393
+ from .serializers import ProductSerializer, ProductCreateSerializer
394
+ from .permissions import IsOwnerOrReadOnly
395
+ from .filters import ProductFilter
396
+ from .services import ProductService
397
+
398
+ class ProductViewSet(viewsets.ModelViewSet):
399
+ """ViewSet for Product model."""
400
+
401
+ queryset = Product.objects.select_related('category').prefetch_related('tags')
402
+ permission_classes = [IsAuthenticated, IsOwnerOrReadOnly]
403
+ filter_backends = [DjangoFilterBackend, filters.SearchFilter, filters.OrderingFilter]
404
+ filterset_class = ProductFilter
405
+ search_fields = ['name', 'description']
406
+ ordering_fields = ['price', 'created_at', 'name']
407
+ ordering = ['-created_at']
408
+
409
+ def get_serializer_class(self):
410
+ """Return appropriate serializer based on action."""
411
+ if self.action == 'create':
412
+ return ProductCreateSerializer
413
+ return ProductSerializer
414
+
415
+ def perform_create(self, serializer):
416
+ """Save with user context."""
417
+ serializer.save(created_by=self.request.user)
418
+
419
+ @action(detail=False, methods=['get'])
420
+ def featured(self, request):
421
+ """Return featured products."""
422
+ featured = self.queryset.filter(is_featured=True)[:10]
423
+ serializer = self.get_serializer(featured, many=True)
424
+ return Response(serializer.data)
425
+
426
+ @action(detail=True, methods=['post'])
427
+ def purchase(self, request, pk=None):
428
+ """Purchase a product."""
429
+ product = self.get_object()
430
+ service = ProductService()
431
+ result = service.purchase(product, request.user)
432
+ return Response(result, status=status.HTTP_201_CREATED)
433
+
434
+ @action(detail=False, methods=['get'], permission_classes=[IsAuthenticated])
435
+ def my_products(self, request):
436
+ """Return products created by current user."""
437
+ products = self.queryset.filter(created_by=request.user)
438
+ page = self.paginate_queryset(products)
439
+ serializer = self.get_serializer(page, many=True)
440
+ return self.get_paginated_response(serializer.data)
441
+ ```
442
+
443
+ ### Custom Actions
444
+
445
+ ```python
446
+ from rest_framework.decorators import api_view, permission_classes
447
+ from rest_framework.permissions import IsAuthenticated
448
+ from rest_framework.response import Response
449
+
450
+ @api_view(['POST'])
451
+ @permission_classes([IsAuthenticated])
452
+ def add_to_cart(request):
453
+ """Add product to user cart."""
454
+ product_id = request.data.get('product_id')
455
+ quantity = request.data.get('quantity', 1)
456
+
457
+ try:
458
+ product = Product.objects.get(id=product_id)
459
+ except Product.DoesNotExist:
460
+ return Response(
461
+ {'error': 'Product not found'},
462
+ status=status.HTTP_404_NOT_FOUND
463
+ )
464
+
465
+ cart, _ = Cart.objects.get_or_create(user=request.user)
466
+ CartItem.objects.create(
467
+ cart=cart,
468
+ product=product,
469
+ quantity=quantity
470
+ )
471
+
472
+ return Response({'message': 'Added to cart'}, status=status.HTTP_201_CREATED)
473
+ ```
474
+
475
+ ## Service Layer Pattern
476
+
477
+ ```python
478
+ # apps/orders/services.py
479
+ from typing import Optional
480
+ from django.db import transaction
481
+ from .models import Order, OrderItem
482
+
483
+ class OrderService:
484
+ """Service layer for order-related business logic."""
485
+
486
+ @staticmethod
487
+ @transaction.atomic
488
+ def create_order(user, cart: Cart) -> Order:
489
+ """Create order from cart."""
490
+ order = Order.objects.create(
491
+ user=user,
492
+ total_price=cart.total_price
493
+ )
494
+
495
+ for item in cart.items.all():
496
+ OrderItem.objects.create(
497
+ order=order,
498
+ product=item.product,
499
+ quantity=item.quantity,
500
+ price=item.product.price
501
+ )
502
+
503
+ # Clear cart
504
+ cart.items.all().delete()
505
+
506
+ return order
507
+
508
+ @staticmethod
509
+ def process_payment(order: Order, payment_data: dict) -> bool:
510
+ """Process payment for order."""
511
+ # Integration with payment gateway
512
+ payment = PaymentGateway.charge(
513
+ amount=order.total_price,
514
+ token=payment_data['token']
515
+ )
516
+
517
+ if payment.success:
518
+ order.status = Order.Status.PAID
519
+ order.save()
520
+ # Send confirmation email
521
+ OrderService.send_confirmation_email(order)
522
+ return True
523
+
524
+ return False
525
+
526
+ @staticmethod
527
+ def send_confirmation_email(order: Order):
528
+ """Send order confirmation email."""
529
+ # Email sending logic
530
+ pass
531
+ ```
532
+
533
+ ## Caching Strategies
534
+
535
+ ### View-Level Caching
536
+
537
+ ```python
538
+ from django.views.decorators.cache import cache_page
539
+ from django.utils.decorators import method_decorator
540
+
541
+ @method_decorator(cache_page(60 * 15), name='dispatch') # 15 minutes
542
+ class ProductListView(generic.ListView):
543
+ model = Product
544
+ template_name = 'products/list.html'
545
+ context_object_name = 'products'
546
+ ```
547
+
548
+ ### Template Fragment Caching
549
+
550
+ ```django
551
+ {% load cache %}
552
+ {% cache 500 sidebar %}
553
+ ... expensive sidebar content ...
554
+ {% endcache %}
555
+ ```
556
+
557
+ ### Low-Level Caching
558
+
559
+ ```python
560
+ from django.core.cache import cache
561
+
562
+ def get_featured_products():
563
+ """Get featured products with caching."""
564
+ cache_key = 'featured_products'
565
+ products = cache.get(cache_key)
566
+
567
+ if products is None:
568
+ products = list(Product.objects.filter(is_featured=True))
569
+ cache.set(cache_key, products, timeout=60 * 15) # 15 minutes
570
+
571
+ return products
572
+ ```
573
+
574
+ ### QuerySet Caching
575
+
576
+ ```python
577
+ from django.core.cache import cache
578
+
579
+ def get_popular_categories():
580
+ cache_key = 'popular_categories'
581
+ categories = cache.get(cache_key)
582
+
583
+ if categories is None:
584
+ categories = list(Category.objects.annotate(
585
+ product_count=Count('products')
586
+ ).filter(product_count__gt=10).order_by('-product_count')[:20])
587
+ cache.set(cache_key, categories, timeout=60 * 60) # 1 hour
588
+
589
+ return categories
590
+ ```
591
+
592
+ ## Signals
593
+
594
+ ### Signal Patterns
595
+
596
+ ```python
597
+ # apps/users/signals.py
598
+ from django.db.models.signals import post_save
599
+ from django.dispatch import receiver
600
+ from django.contrib.auth import get_user_model
601
+ from .models import Profile
602
+
603
+ User = get_user_model()
604
+
605
+ @receiver(post_save, sender=User)
606
+ def create_user_profile(sender, instance, created, **kwargs):
607
+ """Create profile when user is created."""
608
+ if created:
609
+ Profile.objects.create(user=instance)
610
+
611
+ @receiver(post_save, sender=User)
612
+ def save_user_profile(sender, instance, **kwargs):
613
+ """Save profile when user is saved."""
614
+ instance.profile.save()
615
+
616
+ # apps/users/apps.py
617
+ from django.apps import AppConfig
618
+
619
+ class UsersConfig(AppConfig):
620
+ default_auto_field = 'django.db.models.BigAutoField'
621
+ name = 'apps.users'
622
+
623
+ def ready(self):
624
+ """Import signals when app is ready."""
625
+ import apps.users.signals
626
+ ```
627
+
628
+ ## Middleware
629
+
630
+ ### Custom Middleware
631
+
632
+ ```python
633
+ # middleware/active_user_middleware.py
634
+ import time
635
+ from django.utils.deprecation import MiddlewareMixin
636
+
637
+ class ActiveUserMiddleware(MiddlewareMixin):
638
+ """Middleware to track active users."""
639
+
640
+ def process_request(self, request):
641
+ """Process incoming request."""
642
+ if request.user.is_authenticated:
643
+ # Update last active time
644
+ request.user.last_active = timezone.now()
645
+ request.user.save(update_fields=['last_active'])
646
+
647
+ class RequestLoggingMiddleware(MiddlewareMixin):
648
+ """Middleware for logging requests."""
649
+
650
+ def process_request(self, request):
651
+ """Log request start time."""
652
+ request.start_time = time.time()
653
+
654
+ def process_response(self, request, response):
655
+ """Log request duration."""
656
+ if hasattr(request, 'start_time'):
657
+ duration = time.time() - request.start_time
658
+ logger.info(f'{request.method} {request.path} - {response.status_code} - {duration:.3f}s')
659
+ return response
660
+ ```
661
+
662
+ ## Performance Optimization
663
+
664
+ ### N+1 Query Prevention
665
+
666
+ ```python
667
+ # Bad - N+1 queries
668
+ products = Product.objects.all()
669
+ for product in products:
670
+ print(product.category.name) # Separate query for each product
671
+
672
+ # Good - Single query with select_related
673
+ products = Product.objects.select_related('category').all()
674
+ for product in products:
675
+ print(product.category.name)
676
+
677
+ # Good - Prefetch for many-to-many
678
+ products = Product.objects.prefetch_related('tags').all()
679
+ for product in products:
680
+ for tag in product.tags.all():
681
+ print(tag.name)
682
+ ```
683
+
684
+ ### Database Indexing
685
+
686
+ ```python
687
+ class Product(models.Model):
688
+ name = models.CharField(max_length=200, db_index=True)
689
+ slug = models.SlugField(unique=True)
690
+ category = models.ForeignKey('Category', on_delete=models.CASCADE)
691
+ created_at = models.DateTimeField(auto_now_add=True)
692
+
693
+ class Meta:
694
+ indexes = [
695
+ models.Index(fields=['name']),
696
+ models.Index(fields=['-created_at']),
697
+ models.Index(fields=['category', 'created_at']),
698
+ ]
699
+ ```
700
+
701
+ ### Bulk Operations
702
+
703
+ ```python
704
+ # Bulk create
705
+ Product.objects.bulk_create([
706
+ Product(name=f'Product {i}', price=10.00)
707
+ for i in range(1000)
708
+ ])
709
+
710
+ # Bulk update
711
+ products = Product.objects.all()[:100]
712
+ for product in products:
713
+ product.is_active = True
714
+ Product.objects.bulk_update(products, ['is_active'])
715
+
716
+ # Bulk delete
717
+ Product.objects.filter(stock=0).delete()
718
+ ```
719
+
720
+ ## Quick Reference
721
+
722
+ | Pattern | Description |
723
+ |---------|-------------|
724
+ | Split settings | Separate dev/prod/test settings |
725
+ | Custom QuerySet | Reusable query methods |
726
+ | Service Layer | Business logic separation |
727
+ | ViewSet | REST API endpoints |
728
+ | Serializer validation | Request/response transformation |
729
+ | select_related | Foreign key optimization |
730
+ | prefetch_related | Many-to-many optimization |
731
+ | Cache first | Cache expensive operations |
732
+ | Signals | Event-driven actions |
733
+ | Middleware | Request/response processing |
734
+
735
+ Remember: Django provides many shortcuts, but for production applications, structure and organization matter more than concise code. Build for maintainability.