Skip to content

Commit 9a03733

Browse files
codethiefcodethief
committedOct 4, 2024
Initial version
0 parents  commit 9a03733

10 files changed

+317
-0
lines changed
 

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.venv

‎.tool-versions

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
python 3.12.1
2+
poetry 1.8.3

‎Dockerfile

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
FROM debian:bookworm-20240926-slim AS base
2+
3+
RUN apt-get update && \
4+
apt-get install --yes --no-install-recommends \
5+
# Dependencies needed to install asdf
6+
ca-certificates \
7+
git \
8+
# Dependencies needed by asdf-python/pyenv to build Python from source,
9+
# compare
10+
# https://github.com/pyenv/pyenv/wiki#suggested-build-environment
11+
build-essential libssl-dev zlib1g-dev \
12+
libbz2-dev libreadline-dev libsqlite3-dev curl git \
13+
libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev \
14+
# Dependencies needed to install asdf-poetry (yup…)
15+
python3
16+
17+
# Use non-root user for security reasons
18+
RUN useradd --user-group --create-home --shell /bin/bash user
19+
# Need home dir for Poetry to work. (It writes its cache there during
20+
# installation.)
21+
22+
# Need Bash for .bashrc to work.
23+
SHELL ["/bin/bash", "-c"]
24+
25+
ENV OUR_WORKDIR=/workdir
26+
RUN mkdir -p $OUR_WORKDIR && chown user:user $OUR_WORKDIR
27+
28+
WORKDIR $OUR_WORKDIR
29+
USER user
30+
31+
COPY --chown=user:user asdf_bootstrap.sh .
32+
COPY --chown=user:user .tool-versions .
33+
34+
RUN ./asdf_bootstrap.sh
35+
36+
# Make asdf available also in non-interactive Bash shells, including all
37+
# subsequent RUN commands and images that inherit from us.
38+
# -- When Bash is invoked as /bin/sh:
39+
ENV ENV="/home/user/.bashrc"
40+
# -- When Bash is invoked as /bin/bash:
41+
ENV BASH_ENV="/home/user/.bashrc"
42+
43+
44+
COPY --chown=user:user poetry.lock .
45+
COPY --chown=user:user poetry.toml .
46+
COPY --chown=user:user pyproject.toml .
47+
48+
# Ensure poetry.lock matches pyproject.toml
49+
RUN if ! poetry check --lock; then exit 1; fi
50+
51+
# https://github.com/python-poetry/poetry/issues/8761
52+
ENV PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring
53+
54+
RUN poetry install
55+
56+
# Add application code as a very last step, so that image layer cache doesn't
57+
# get busted unnecessarily
58+
COPY --chown=user:user src/* ./src/
59+
60+
CMD ["src/main.py"]

‎LICENSE

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
This is free and unencumbered software released into the public domain.
2+
3+
Anyone is free to copy, modify, publish, use, compile, sell, or
4+
distribute this software, either in source code form or as a compiled
5+
binary, for any purpose, commercial or non-commercial, and by any
6+
means.
7+
8+
In jurisdictions that recognize copyright laws, the author or authors
9+
of this software dedicate any and all copyright interest in the
10+
software to the public domain. We make this dedication for the benefit
11+
of the public at large and to the detriment of our heirs and
12+
successors. We intend this dedication to be an overt act of
13+
relinquishment in perpetuity of all present and future rights to this
14+
software under copyright law.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20+
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
OTHER DEALINGS IN THE SOFTWARE.
23+
24+
For more information, please refer to <http://unlicense.org>

‎README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
This an example project demonstrating how to dockerize a basic Python
2+
application that uses [asdf](https://asdf-vm.com/) and
3+
[Poetry](https://github.com/python-poetry/poetry/) for dependency management.
4+
5+
# Caveats
6+
- The generated Docker image contains a few dependencies that are not needed at
7+
application runtime. Ideally, one would use a multi-stage Docker build in
8+
order to not include those in the final Docker image and make the image
9+
smaller.
10+
- apt dependencies are not fully pinned. Use e.g.
11+
[repro-sources-list.sh](https://github.com/reproducible-containers/repro-sources-list.sh)
12+
to achieve that.

‎asdf_bootstrap.sh

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#!/usr/bin/env bash
2+
3+
# This installs asdf to the home dir, adapts the Bash config, and installs all
4+
# plugins & tools from .tool-versions.
5+
#
6+
# Assumption: Working dir contains the .tool-versions file.
7+
8+
set -ex
9+
10+
git clone --depth 1 https://github.com/asdf-vm/asdf.git "$HOME/.asdf" --branch v0.14.1
11+
12+
ASDF_SOURCE_FILE="$HOME/.asdf/asdf.sh"
13+
14+
# Make asdf available…
15+
# …in future login shells
16+
echo ". $ASDF_SOURCE_FILE" > $HOME/.bashrc
17+
# …in future non-login shells
18+
echo ". $ASDF_SOURCE_FILE" > $HOME/.profile
19+
# …and make it available now!
20+
. "$ASDF_SOURCE_FILE"
21+
22+
# asdf doesn't support auto-installing plugins mentioned in .tool-versions, see
23+
# https://github.com/asdf-vm/asdf/issues/276 , so let's do this manually.
24+
cat .tool-versions | cut -d' ' -f1 | grep "^[^\#]" | xargs -I{} sh -c 'asdf plugin add {} > /dev/null'
25+
26+
# Install the required tool versions listed in .tool-versions
27+
asdf install

‎poetry.lock

+168
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎poetry.toml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[virtualenvs]
2+
in-project = true
3+
prefer-active-python = true

‎pyproject.toml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[tool.poetry]
2+
name = "example-project"
3+
package-mode = false
4+
5+
[tool.poetry.dependencies]
6+
python = "^3.12" # Keep this in sync w/ .tool-versions (which should be the main source of truth)
7+
pytest = "^7.4.4"
8+
ruff = "^0.1.13"
9+
mypy = "^1.8.0"
10+
11+
[tool.ruff]
12+
target-version = "py312" # Keep this in sync w/ .tool-versions (which should be the main source of truth)
13+
14+
[build-system]
15+
requires = ["poetry-core"]
16+
build-backend = "poetry.core.masonry.api"

‎src/main.py

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env python3
2+
3+
if __name__ == "__main__":
4+
print("Hello, world!")

0 commit comments

Comments
 (0)
Please sign in to comment.