Skip to content

Switch to absolute URLs in readmes so links aren't broken on PyPI. #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
erikrose wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Switch to absolute URLs in readmes so links aren't broken on PyPI. #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,30 @@ Here's how to write your own Python WSGI app and run it on Fastly's edge network
1. Install the package that provides the Fastly Python build tool and gives you access to the Fastly API:

`pip install fastly-compute`
2. Make a project shaped like [our Flask example](/examples/flask-app). You may find it easiest to clone the [repository](/), copy the `examples/flask-app` folder, and modify it. If you change the name of the top-level `.py` file, be sure to also update the entrypoint (`entry = "your_top_level_module_name"`) in `pyproject.toml`.
3. `cd your-project`
4. Install the [Fastly CLI](https://www.fastly.com/documentation/reference/tools/cli/) if you don't already have it.
5. `fastly compute init`
6. Say yes when warned "The current directory isn't empty." Answer "Other" when it asks for Language.
7. Add this to the bottom of `fastly.toml`:
2. Make a project shaped like [our Flask example](https://github.com/fastly/compute-sdk-python/blob/main/examples/flask-app). You may find it easiest to clone the [repository](https://github.com/fastly/compute-sdk-python/), copy the `examples/flask-app` folder, and modify it. If you change the name of the top-level `.py` file, be sure to also update the entrypoint (`entry = "your_top_level_module_name"`) in `pyproject.toml`.
3. If your project imports from `Flask` or `bottle` like ours do, pip-install whichever of them you need:
```
pip install Flask
```
```
pip install Bottle
```
Copy link
Copy Markdown
Member

@posborne posborne Jun 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

4. `cd your-project`
5. Install the [Fastly CLI](https://www.fastly.com/documentation/reference/tools/cli/) if you don't already have it.
6. `fastly compute init`
7. Say yes when warned "The current directory isn't empty." Answer "Other" when it asks for Language.
8. Add this to the bottom of `fastly.toml`:
```
[scripts]
build = "fastly-compute-py build"
```

8. `fastly compute build`
9. `fastly compute deploy`
9. `fastly compute build`
10. `fastly compute deploy`

## Run Some Examples on Your Own Machine

We ship [a few simple examples](examples/README.md) you can run locally to get a taste of what's possible.
We ship [a few simple examples](https://github.com/fastly/compute-sdk-python/blob/main/examples/README.md) you can run locally to get a taste of what's possible.

## Status

Expand All @@ -55,4 +62,4 @@ Currently supports...

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).
See [CONTRIBUTING.md](https://github.com/fastly/compute-sdk-python/blob/main/CONTRIBUTING.md).
2 changes: 1 addition & 1 deletion examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This is actually a piece of the test harness; please ignore it.

## Building and Running Examples

Before you use `make`, please [install the prerequisites](../CONTRIBUTING.md#prerequisites).
Before you use `make`, please [install the prerequisites](https://github.com/fastly/compute-sdk-python/blob/main/CONTRIBUTING.md#prerequisites).

### Hello World in Flask or Bottle
```bash
Expand Down
Loading