|
1 | 1 | # python-uv-devcontainer
|
2 | 2 |
|
3 |
| -[](https://github.com/astral-sh/ruff) [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/dunnkers/python-uv-devcontainer.git) |
| 3 | +[](https://github.com/astral-sh/uv) [](https://github.com/astral-sh/ruff) [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/dunnkers/python-uv-devcontainer.git) |
4 | 4 |
|
5 | 5 |
|
6 | 6 | Python project setup using a [Devcontainer](https://containers.dev) and [uv](https://github.com/astral-sh/uv).
|
7 | 7 |
|
8 | 8 | ## Features
|
9 | 9 |
|
10 | 10 | - [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 [](https://github.com/astral-sh/uv) |
| 11 | +- [x] [uv](https://github.com/astral-sh/uv) for dependency management and virtual environment management |
12 | 12 | - [x] [ruff](https://github.com/astral-sh/ruff) for formatting and linting
|
13 | 13 | - [x] [pytest](https://docs.pytest.org/en/stable/) for testing
|
14 | 14 | - [x] [GitHub Actions](https://github.com/dunnkers/python-uv-devcontainer/actions) for CI/CD
|
15 | 15 | - [x] [Dockerfile](https://github.com/dunnkers/python-uv-devcontainer/blob/main/Dockerfile) for easy deployment
|
16 | 16 |
|
17 | 17 | ## Setup
|
18 | 18 |
|
19 |
| -Setup is easy. Follow these steps to setup using **VSCode**: |
| 19 | +Getting started is easy. Follow these steps: |
20 | 20 |
|
21 | 21 | 1. **Use this template**
|
22 | 22 |
|
23 | 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 | 24 |
|
25 | 25 | [Create a new repository](https://github.com/new?template_name=python-uv-devcontainer&template_owner=dunnkers) based on this template.
|
26 | 26 |
|
27 |
| - > Alternatively, you can also open the repository in a GitHub Codespace: |
28 |
| - > [](https://codespaces.new/dunnkers/python-uv-devcontainer?quickstart=1) |
29 |
| -
|
30 | 27 | 2. **Clone repo**
|
31 | 28 |
|
32 | 29 | <img src="https://github.com/user-attachments/assets/3aa1891b-d19b-4c8e-acad-b5e46eb18250" alt="Clone repository" width="375"/>
|
33 | 30 |
|
34 |
| - Open the repo in VSCode. |
| 31 | + Open the repo in **VSCode**. |
35 | 32 |
|
36 | 33 | 3. **Reopen in Container**
|
37 | 34 |
|
|
0 commit comments