Skip to content

Commit 23fcdf6

Browse files
Documented graphviz install
1 parent 786b411 commit 23fcdf6

File tree

1 file changed

+42
-5
lines changed

1 file changed

+42
-5
lines changed

README.md

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,30 @@ disadvantage is that it requires an extra round trip to the database to
2323
fetch the updated data, and re-rendering the entire page template may be
2424
less efficient than a partial page update on the client side.
2525

26-
### Install development dependencies
26+
### Install development dependencies in a VSCode Dev Container
27+
28+
If you use VSCode with Docker, the following VSCode Dev Container configuration will install all dependencies and automatically open the project in a container:
29+
30+
``` json
31+
{
32+
"name": "Python 3",
33+
"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
34+
"postCreateCommand": "sudo apt update && sudo apt install -y python3-dev libpq-dev graphviz && pipx install poetry && poetry install && poetry shell",
35+
"features": {
36+
"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
37+
"ghcr.io/rocker-org/devcontainer-features/quarto-cli:1": {}
38+
}
39+
}
40+
```
41+
42+
Simply create a .devcontainer folder in the root of the project and add a devcontainer.json file with this content, and then "Reopen in Container" from View > Command Palette.
43+
44+
### Install development dependencies manually
2745

28-
#### Python, Docker, and Quarto CLI
46+
#### Python and Docker
2947

3048
- [Python 3.12 or higher](https://www.python.org/downloads/)
3149
- [Docker and Docker Compose](https://docs.docker.com/get-docker/)
32-
- [Quarto CLI](https://quarto.org/docs/get-started/)
3350

3451
#### PostgreSQL headers
3552

@@ -47,8 +64,28 @@ brew install postgresql
4764

4865
For Windows:
4966

50-
- No additional system dependencies required
51-
- Install Python from the official Python website
67+
- No installation required
68+
69+
#### Quarto CLI and Graphviz
70+
71+
- [Quarto CLI](https://quarto.org/docs/get-started/)
72+
73+
74+
For macOS:
75+
76+
``` bash
77+
brew install graphviz
78+
```
79+
80+
For Ubuntu/Debian:
81+
82+
``` bash
83+
sudo apt update && sudo apt install -y graphviz
84+
```
85+
86+
For Windows:
87+
88+
- Download and install from [Graphviz.org](https://graphviz.org/download/#windows)
5289

5390
#### Python dependencies
5491

0 commit comments

Comments
 (0)