Skip to content

Commit 545e971

Browse files
committed
Badges and improvements
1 parent 48d1657 commit 545e971

File tree

2 files changed

+37
-24
lines changed

2 files changed

+37
-24
lines changed

README.md

Lines changed: 36 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
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)
4+
5+
36
Python project setup using a [Devcontainer](https://containers.dev) and [uv](https://github.com/astral-sh/uv).
47

58
## Features
@@ -13,45 +16,53 @@ Python project setup using a [Devcontainer](https://containers.dev) and [uv](htt
1316

1417
## Setup
1518

16-
1. **Use this template**
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).
1720

18-
<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>
19-
20-
[Create a new repository](https://github.com/new?template_name=python-uv-devcontainer&template_owner=dunnkers) based on this template.
21+
1. **GitHub Codespace**
2122

22-
2. **Clone repo**
23+
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/dunnkers/python-uv-devcontainer?quickstart=1)
2324

24-
<img src="https://github.com/user-attachments/assets/3aa1891b-d19b-4c8e-acad-b5e46eb18250" alt="Clone repository" width="375"/>
25+
2. **VSCode Devcontainer**
2526

26-
Open the repo in VSCode.
27+
1. **Use this template**
2728

28-
> [!TIP]
29-
> This Devcontainer can also be directly used with a GitHub Codespace.
30-
> [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/dunnkers/python-uv-devcontainer?quickstart=1)
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.
3132

32-
3. **Reopen in Container**
33+
2. **Clone repo**
3334

34-
Click the button in the popup upon opening the repo:
35-
36-
<img src="https://github.com/user-attachments/assets/c89c6643-768b-427d-b10f-a51ddbe76282" alt="Dev Containers: Reopen in Container" width="475"/>
35+
<img src="https://github.com/user-attachments/assets/3aa1891b-d19b-4c8e-acad-b5e46eb18250" alt="Clone repository" width="375"/>
36+
37+
Open the repo in VSCode.
3738

38-
Alternatively, enter <kbd>Ctrl+Shift+P</kbd> and select **Dev Containers: Reopen in Container**.
39+
> [!TIP]
40+
> This Devcontainer can also be directly used with a GitHub Codespace.
41+
>
3942
40-
4. **Wait for setup to finish**
43+
3. **Reopen in Container**
4144

42-
Upon opening the Devcontainer, setup will start. Wait for the setup to finish before continuing.
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"/>
4348

44-
<img src="https://github.com/user-attachments/assets/28dceed1-abb2-4be5-aa25-ff1c8ad38455" alt="Wait for postCreateCommand to finish" width="600"/>
49+
Alternatively, enter <kbd>Ctrl+Shift+P</kbd> and select **Dev Containers: Reopen in Container**.
4550

46-
5. **Select Python interpreter**
51+
4. **Wait for setup to finish**
4752

48-
Enter <kbd>Ctrl+Shift+P</kbd> and select **Python: Select Interpreter**.
53+
Upon opening the Devcontainer, setup will start. Wait for the setup to finish before continuing.
4954

50-
<img src="https://github.com/user-attachments/assets/3efa1de7-5bd3-4b1e-aaa8-455773396c81" alt="VSCode: Python Select Interpreter" width="500"/>
55+
<img src="https://github.com/user-attachments/assets/28dceed1-abb2-4be5-aa25-ff1c8ad38455" alt="Wait for postCreateCommand to finish" width="600"/>
5156

52-
Select the **venv** (`./.venv/bin/python`).
57+
5. **Select Python interpreter**
5358

54-
6. **Enjoy 🫶**
59+
Enter <kbd>Ctrl+Shift+P</kbd> and select **Python: Select Interpreter**.
60+
61+
<img src="https://github.com/user-attachments/assets/3efa1de7-5bd3-4b1e-aaa8-455773396c81" alt="VSCode: Python Select Interpreter" width="500"/>
62+
63+
Select the **venv** (`./.venv/bin/python`).
64+
65+
3. **Enjoy 🫶**
5566

5667
You now have a fully configured Python development environment!
5768

@@ -87,6 +98,8 @@ Python project setup using a [Devcontainer](https://containers.dev) and [uv](htt
8798

8899
A [Dockerfile](https://github.com/dunnkers/python-uv-devcontainer/blob/main/Dockerfile) is provided for easy deployment. This Dockerfile uses the same base image as the Devcontainer, so you can be sure it will work in production.
89100

101+
102+
90103

91104
## About
92105

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[project]
2-
name = "python-project-setup-with-uv"
2+
name = "python-uv-devcontainer"
33
version = "0.1.0"
44
description = "Add your description here"
55
readme = "README.md"

0 commit comments

Comments
 (0)