Skip to content

Commit 12e14be

Browse files
committed
Explanation
1 parent 6fec24c commit 12e14be

File tree

1 file changed

+10
-51
lines changed

1 file changed

+10
-51
lines changed

README.md

Lines changed: 10 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

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

5+
Features:
6+
7+
- [x] [Devcontainer](https://github.com/devcontainers/images/tree/main/src/python) running Python 3.13
8+
- [x] [uv](https://github.com/astral-sh/uv) for dependency management and virtual environment management
9+
- [x] [ruff](https://github.com/astral-sh/ruff) for formatting and linting
10+
- [x] [pytest](https://docs.pytest.org/en/stable/) for testing
11+
- [x] [Dockerfile](https://github.com/dunnkers/python-uv-devcontainer/blob/main/Dockerfile) for easy deployment
12+
- [x] [GitHub Actions](https://github.com/dunnkers/python-uv-devcontainer/actions) for CI/CD
13+
14+
515
## Setup
616

717
1. **Clone this repo**
@@ -23,57 +33,6 @@ Python project setup using a [Devcontainer](https://containers.dev) and [uv](htt
2333

2434
🎉
2535

26-
## Features
27-
28-
- **pytest**
29-
30-
Run tests with pytest.
31-
32-
```
33-
pytest tests
34-
```
35-
36-
- **uv**
37-
38-
Dependency management and virtual environment management with uv.
39-
40-
```
41-
uv add pandas
42-
```
43-
44-
- **ruff**
45-
46-
Linting and formatting with ruff.
47-
48-
Linting:
49-
50-
```
51-
ruff check .
52-
```
53-
54-
Formatting:
55-
56-
```
57-
ruff format .
58-
```
59-
60-
- **CI/CD**
61-
62-
CI/CD with GitHub Actions.
63-
64-
- **Linting**: Linting with ruff.
65-
- **Formatting**: Formatting with ruff.
66-
- **Testing**: Testing with pytest.
67-
- **Dependency management**: Dependency management with uv.
68-
69-
- **Docker**
70-
71-
Build and run your Python project in a Docker container.
72-
73-
```
74-
docker build -t my-python-app .
75-
```
76-
7736
## About
7837

7938
Provided to you with ♡ by [Jeroen Overschie](https://jeroenoverschie.nl/).

0 commit comments

Comments
 (0)