docs(examples): add pyproject.toml to rasa demo project#160
Conversation
Ship the canonical Rasa Pro manifest with the bundled CALM demo so users who install via Poetry get the rasa-pro private registry and the pinned version out of the box, matching Rasa's recommended developer experience. Closes #148.
ff01635 to
f393b8c
Compare
rasa-pro 3.14.0 imports language_data at validation time but does not declare it in its dependency graph, so a fresh poetry install followed by rasa train fails with ModuleNotFoundError. Pin language-data explicitly and ship the lockfile so users get a reproducible install out of the box, matching the pattern in Rasa's own rasa-calm-demo. The lockfile (773KB) is narrowly exempted from the check-added-large-files hook; the global 500KB policy is unchanged. Smoke-tested end-to-end: poetry install, rasa train, rasa run, and arksim simulate-evaluate against all four bundled scenarios.
Smoke-tested end-to-end locally ✅Ran the full PR test plan from a clean Poetry install:
Follow-ups folded in (commit
|
- prefix rasa train/run commands with poetry run so they pick up the venv created by poetry install - align advertised python range with pyproject (3.10-3.13) - add arksim-install hint at top of prerequisites - explain what RASA_LICENSE and OPENAI_API_KEY are each used for - flag --cors "*" and REST-with-no-token as local-dev-only - point at rasa's own install docs for the private-registry auth step rather than inventing the incantation - expand changelog entry so grep finds the language-data workaround
|
Hey Rod, thanks again for #148. We smoke-tested the full install + train + serve + eval flow end-to-end and a few things surfaced that I'd love your read on before we finalize, since they're more your canon than ours. 1. Version pin. We kept 2. 3. Shipping 4. Registry auth for the supplemental source. I linked users at Rasa's install guide for the first-time 5. 6. Framing. Package name is currently Everything arksim-side has been tightened on branch |
Summary
Ships the canonical Rasa Pro manifest alongside the bundled CALM demo at
examples/integrations/rasa/rasa_project/, so users onboarding through the arksim Rasa integration get Rasa's blessed Poetry toolchain, therasa-proprivate GCP registry, and a pinned version out of the box.examples/integrations/rasa/rasa_project/pyproject.toml: Poetry build-system,package-mode = false, pinsrasa-pro = 3.14.0from theeurope-west3registry.README.mdprerequisites now lead withpoetry install, keepsuv pip/pipas standalone fallback.[Unreleased] → Addedentry referencing pyproject.toml #148.Scope
Only the Rasa example subtree is touched. The root arksim
pyproject.toml(hatchling + hatch-vcs) is unchanged, and no runtime code, CI, or tests are affected.Test plan
cd examples/integrations/rasa/rasa_project && poetry installresolvesrasa-pro==3.14.0from the Rasa registry (requiresRASA_PRO_LICENSE/ registry auth).rasa train && rasa run --enable-apistill launches the demo assistant after a Poetry-based install.arksim simulate-evaluate config.yamlfrom the parent directory completes the four bundled scenarios.Closes #148.
cc @profrodai, picked up your suggestion from #148. Renamed the package to
arksim-rasa-calm-demoand setpackage-mode = falseso it doesn't try to build as a distributable, but kept the registry block and version pin as you spec'd. Let me know if you'd prefer a different version or wanttomlswapped for something else in the dev group.