File tree 1 file changed +33
-1
lines changed
1 file changed +33
-1
lines changed Original file line number Diff line number Diff line change @@ -4,7 +4,7 @@ An example project for using uv in Dockerfiles.
4
4
5
5
See the [ uv Docker integration guide] ( https://docs.astral.sh/uv/guides/integration/docker/ ) for more details.
6
6
7
- ## Running the image
7
+ ## Trying it out
8
8
9
9
A [ ` run.sh ` ] ( ./run.sh ) utility is provided for quickly building the image and starting a container.
10
10
@@ -28,3 +28,35 @@ To enter a `bash` shell in the image:
28
28
```
29
29
./run.sh /bin/bash
30
30
```
31
+
32
+ ## Project overview
33
+
34
+ ### Dockerfile
35
+
36
+ The [ ` Dockerfile ` ] ( ./Dockerfile ) defines the image and includes:
37
+
38
+ - Installation of uv
39
+ - Installing the project dependencies and the project separately for optimal image build caching
40
+ - Placing environment executables on the ` PATH `
41
+
42
+ ### Docker ignore file
43
+
44
+ The [ ` .dockerignore ` ] ( ./.dockerignore ) file includes an entry for the ` .venv ` directory to ensure the
45
+ ` .venv ` is not included in image builds. Note that the ` .dockerignore ` file is not applied to volume
46
+ mounts during container runs.
47
+
48
+ ### Run script
49
+
50
+ The [ run script] ( ./run.sh ) includes an example of invoking ` docker run ` for local development,
51
+ mounting the source code for the project into the container so that edits are reflected immediately.
52
+
53
+ ### Application code
54
+
55
+ The Python application code for the project is at
56
+ [ ` src/uv_docker_example/__init__.py ` ] ( ./src/uv_docker_example/__init__.py ) — it just prints hello
57
+ world.
58
+
59
+ ### Project definition
60
+
61
+ The project at [ ` pyproject.toml ` ] ( ./pyproject.toml ) includes includes Ruff as an example development
62
+ dependency and defines a ` hello ` entrypoint for the application.
You can’t perform that action at this time.
0 commit comments