docs(cli): align preset module lists with actual smpy new behavior - #145
Merged
antosubash merged 1 commit intoMay 13, 2026
Merged
Conversation
The installation and quickstart docs described `--preset standard` as including `permissions`, `settings`, and `feature_flags`, but the CLI's `PRESETS` in `framework/cli/simple_module_cli/catalog.py` resolves `standard` to just `auth, users, dashboard, permissions`. Update the docs to match what the CLI actually does, and note that `simple_module_settings` ships as a hard-coded baseline dep of every scaffolded host (which is why it lands in the venv regardless of preset). Fixes #136
Deploying simple-module-python with
|
| Latest commit: |
42de64f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8820df65.simple-module-python.pages.dev |
| Branch Preview URL: | https://feature-feat-smpy-preset-sta.simple-module-python.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
--preset standardshippedauth, users, permissions, dashboard, settings, feature_flags, but the CLI'sPRESETSinframework/cli/simple_module_cli/catalog.py:63-67actually resolvesstandardtoauth, users, dashboard, permissions.--yesblurb to match what the CLI prints.simple_module_settingsis a hardcoded baseline dep inframework/cli/simple_module_cli/templates/host/pyproject.toml.tpl:10, which is why it lands in the venv even onminimal.Fixes #136.
This is option 1 from the issue's suggested fixes (docs follow CLI). Option 2 (expand the
standardpreset in the CLI to includesettings+feature_flags) would be a behavior change for--yescallers, against the original spec's "no behavior change for existing scripts" intent — happy to switch approaches if a richer documented standard is preferred.Test plan
smpy new test --yes --no-installannouncesModules: auth, users, dashboard, permissions(matches table)smpy new test --yes --preset minimal --no-installannouncesModules: auth, users(matches table)smpy new test --yes --preset full --no-installannounces all 8 catalog modules (matches table)