Skip to content

Document requests as a runtime prerequisite #39

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmccoystephenson merged 1 commit into from
Oct 13, 2026
Merged

Document requests as a runtime prerequisite #39

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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ worked example of integrating the class with `Graphik`.

- Python 3.10+
- [Pygame](https://www.pygame.org/) (`pip install pygame`)
- [Requests](https://requests.readthedocs.io/) (`pip install requests`), which Viron's `EnvironmentService` and `LocationService` use to reach the Viron server
- [Viron](https://github.com/Preponderous-Software/Viron), which is vendored as a Git submodule and is also expected to be running as a server (see below)
- Docker, if Viron is to be started from the bundled Compose file

Expand All @@ -95,7 +96,7 @@ Clone the repository along with the `Viron` submodule:
```bash
git clone --recurse-submodules https://github.com/Preponderous-Software/patchwork.git
cd patchwork
pip install pygame
pip install pygame requests
```

If the repository was already cloned without `--recurse-submodules`, the submodule can be populated afterwards:
Expand Down
Loading