Switch to absolute URLs in readmes so links aren't broken on PyPI.#105
Conversation
Also add a conditional quick-start step to install Flask or Bottle, because our examples fail at build time when those aren't around.
| ``` | ||
| ``` | ||
| pip install Bottle | ||
| ``` |
There was a problem hiding this comment.
I think we should really avoid having users do pip install steps at all in favor of having dependencies be modeled in pyproject.toml for relevant examples and pushing uv; I glossed over the pip instructions on first read and think it is detrimental given our prior decision to make uv the paved path and the greater importance of having an isolated virtualenv or similar for targeting the wasm environment.
The manual steps listed are likely to go away in favor of templates for a better getting-started experience, but even then I think as-is, this is probably pushing users down a suboptimal path. Even though there's pretty good flexibility in terms of how things can be done, I think it may be better to document as if use of uv is what is to be used.
There was a problem hiding this comment.
That's fine. I wrote it in terms of pip because I have 20 years of acclimation to putting (and seeing) it in install instructions, and I expected most customers to create a venv implicitly (and those who wouldn't to just get confused by one). But I like your writeup, especially its explanation of each step. We will have to be sure and hold people's hands w.r.t. uv throughout all our docs (e.g. always saying uv run fastly-compute-py), as pip is still the modal path in the community and will turn up in general "what the heck's broken?" searches.
|
Merging to get the fixes that aren't subsumed by #108. |
2 participants
Also add a conditional quick-start step to install Flask or Bottle, because our examples fail at build time when those aren't around.