Skip to content

Commit e722193

Browse files
committed
Update
1 parent 545e971 commit e722193

File tree

1 file changed

+25
-32
lines changed

1 file changed

+25
-32
lines changed

README.md

Lines changed: 25 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,59 @@
11
# python-uv-devcontainer
22

3-
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Open in Remote - Containers](https://img.shields.io/static/v1?label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/dunnkers/python-uv-devcontainer.git)
3+
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Open in Remote - Containers](https://img.shields.io/static/v1?label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/dunnkers/python-uv-devcontainer.git)
44

55

66
Python project setup using a [Devcontainer](https://containers.dev) and [uv](https://github.com/astral-sh/uv).
77

88
## Features
99

1010
- [x] [Devcontainer](https://github.com/devcontainers/images/tree/main/src/python) running Python 3.13
11-
- [x] [uv](https://github.com/astral-sh/uv) for dependency management and virtual environment management
12-
- [x] [pytest](https://docs.pytest.org/en/stable/) for testing
11+
- [x] [uv](https://github.com/astral-sh/uv) for dependency management and virtual environment management [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
1312
- [x] [ruff](https://github.com/astral-sh/ruff) for formatting and linting
13+
- [x] [pytest](https://docs.pytest.org/en/stable/) for testing
1414
- [x] [GitHub Actions](https://github.com/dunnkers/python-uv-devcontainer/actions) for CI/CD
1515
- [x] [Dockerfile](https://github.com/dunnkers/python-uv-devcontainer/blob/main/Dockerfile) for easy deployment
1616

1717
## Setup
1818

19-
Setup is easy. Open this repo in a [GitHub Codespace](https://github.com/features/codespaces) or in a [VSCode Devcontainer](https://code.visualstudio.com/docs/devcontainers/create-dev-container).
20-
21-
1. **GitHub Codespace**
22-
23-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/dunnkers/python-uv-devcontainer?quickstart=1)
19+
Setup is easy. Follow these steps to setup using **VSCode**:
2420

25-
2. **VSCode Devcontainer**
21+
1. **Use this template**
2622

27-
1. **Use this template**
28-
29-
<a href="https://github.com/new?template_name=python-uv-devcontainer&template_owner=dunnkers"><img src="https://github.com/user-attachments/assets/45df28b9-9210-4cd4-a6c5-25ad3c8edb55" alt="Use this template and create new repository" width="250"/></a>
30-
31-
[Create a new repository](https://github.com/new?template_name=python-uv-devcontainer&template_owner=dunnkers) based on this template.
23+
<a href="https://github.com/new?template_name=python-uv-devcontainer&template_owner=dunnkers"><img src="https://github.com/user-attachments/assets/45df28b9-9210-4cd4-a6c5-25ad3c8edb55" alt="Use this template and create new repository" width="250"/></a>
24+
25+
[Create a new repository](https://github.com/new?template_name=python-uv-devcontainer&template_owner=dunnkers) based on this template.
3226

33-
2. **Clone repo**
27+
> Alternatively, you can also open the repository in a GitHub Codespace:
28+
> [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/dunnkers/python-uv-devcontainer?quickstart=1)
3429
35-
<img src="https://github.com/user-attachments/assets/3aa1891b-d19b-4c8e-acad-b5e46eb18250" alt="Clone repository" width="375"/>
30+
2. **Clone repo**
3631

37-
Open the repo in VSCode.
32+
<img src="https://github.com/user-attachments/assets/3aa1891b-d19b-4c8e-acad-b5e46eb18250" alt="Clone repository" width="375"/>
3833

39-
> [!TIP]
40-
> This Devcontainer can also be directly used with a GitHub Codespace.
41-
>
34+
Open the repo in VSCode.
4235

43-
3. **Reopen in Container**
36+
3. **Reopen in Container**
4437

45-
Click the button in the popup upon opening the repo:
46-
47-
<img src="https://github.com/user-attachments/assets/c89c6643-768b-427d-b10f-a51ddbe76282" alt="Dev Containers: Reopen in Container" width="475"/>
38+
Click the button in the popup upon opening the repo:
39+
40+
<img src="https://github.com/user-attachments/assets/c89c6643-768b-427d-b10f-a51ddbe76282" alt="Dev Containers: Reopen in Container" width="475"/>
4841

49-
Alternatively, enter <kbd>Ctrl+Shift+P</kbd> and select **Dev Containers: Reopen in Container**.
42+
Alternatively, enter <kbd>Ctrl+Shift+P</kbd> and select **Dev Containers: Reopen in Container**.
5043

51-
4. **Wait for setup to finish**
44+
4. **Wait for setup to finish**
5245

53-
Upon opening the Devcontainer, setup will start. Wait for the setup to finish before continuing.
46+
Upon opening the Devcontainer, setup will start. Wait for the setup to finish before continuing.
5447

55-
<img src="https://github.com/user-attachments/assets/28dceed1-abb2-4be5-aa25-ff1c8ad38455" alt="Wait for postCreateCommand to finish" width="600"/>
48+
<img src="https://github.com/user-attachments/assets/28dceed1-abb2-4be5-aa25-ff1c8ad38455" alt="Wait for postCreateCommand to finish" width="600"/>
5649

57-
5. **Select Python interpreter**
50+
5. **Select Python interpreter**
5851

59-
Enter <kbd>Ctrl+Shift+P</kbd> and select **Python: Select Interpreter**.
52+
Enter <kbd>Ctrl+Shift+P</kbd> and select **Python: Select Interpreter**.
6053

61-
<img src="https://github.com/user-attachments/assets/3efa1de7-5bd3-4b1e-aaa8-455773396c81" alt="VSCode: Python Select Interpreter" width="500"/>
54+
<img src="https://github.com/user-attachments/assets/3efa1de7-5bd3-4b1e-aaa8-455773396c81" alt="VSCode: Python Select Interpreter" width="500"/>
6255

63-
Select the **venv** (`./.venv/bin/python`).
56+
Select the **venv** (`./.venv/bin/python`).
6457

6558
3. **Enjoy 🫶**
6659

0 commit comments

Comments
 (0)