Skip to content

Commit c804c39

Browse files
committed
More docs and updates
1 parent 78b565d commit c804c39

6 files changed

+28
-4
lines changed

β€ŽREADME.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,47 @@ Python project setup using a [Devcontainer](https://containers.dev) and [uv](htt
1616

1717
1. **Clone this repo**
1818

19-
<img src="docs/Screenshot 2025-04-23 at 17.19.10.png" alt="Clone repository" width="300"/>
19+
<img src="docs/Screenshot 2025-04-23 at 17.19.10.png" alt="Clone repository" width="400"/>
2020
2. **Reopen in Container**
2121

22-
<small>Click the button in the popup upon opening the repo:</small>
22+
Click the button in the popup upon opening the repo:
2323

2424
![alt text](<docs/Screenshot 2025-04-23 at 17.20.22.png>)
2525

2626
Alternatively, enter <kbd>Ctrl+Shift+P</kbd> and select **Dev Containers: Reopen in Container**.
2727

28-
Upon opening the container dependencies will installed. Wait a bit for all dependencies to install.
28+
Upon opening the Devcontainer, setup will start. Wait for the setup to finish.
2929

30-
3. **Enjoy 🫢**
30+
![alt text](<docs/Screenshot 2025-04-23 at 18.00.10.png>)
31+
32+
3. **Select Python interpreter**
33+
34+
Enter <kbd>Ctrl+Shift+P</kbd> and select **Python: Select Interpreter**.
35+
36+
<img src="docs/Screenshot 2025-04-23 at 17.53.28.png" alt="VSCode: Python Select Interpreter" width="500"/>
37+
38+
Select the **venv** (`./.venv/bin/python`).
39+
40+
4. **Enjoy 🫢**
3141

3242
You now have a fully configured Python development environment with uv!
3343

3444
![alt text](<docs/Screenshot 2025-04-23 at 17.29.45.png>)
3545

46+
... with pytest:
47+
48+
![alt text](<docs/Screenshot 2025-04-23 at 17.58.16.png>)
49+
50+
... and tooling like `ruff` and `uv` readily available:
51+
52+
<img src="docs/Screenshot 2025-04-23 at 18.03.49.png" width="500"/>
53+
54+
... and CI/CD set up with GitHub Actions:
55+
56+
![alt text](<docs/Screenshot 2025-04-23 at 18.06.47.png>)
57+
58+
Good luck developing! πŸ€
59+
3660
πŸŽ‰
3761

3862
## About
117 KB
Loading
737 KB
Loading
86.5 KB
Loading
152 KB
Loading
303 KB
Loading

0 commit comments

Comments
Β (0)