Build a docker image (#35)

* add rich to the dependencies, ...

use rich.print() to add some colour to the output
and finally add a test for it

* fix the test workflow

* add Dockerfile, dockerignore

* improve the README, add a docker section

* add docker-publish action

Author: markgreene74

.dockerignore

@@ -0,0 +1,24 @@
+.git/
+.gitignore
+
+build
+dist
+*.egg-info
+*.egg/
+*.pyc
+*.swp
+
+.tox
+.coverage
+html/*
+__pycache__
+*/__pycache__
+
+.pytest_cache/
+*/.pytest_cache/
+
+.vagrant/
+*-vagrant-up.log
+
+.with_*
+.idea/

.github/workflows/docker-publish.yml

@@ -0,0 +1,44 @@
+name: "Build and publish image to GitHub Packages"
+
+on:
+  push:
+    branches: [ "main" ]
+  release:
+    types: [published, released]
+  workflow_dispatch:
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          context: .
+          push: true
+          tags: "${{ steps.meta.outputs.tags }}, ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest, ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.ref_name }}"
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/python-run-tests.yml

@@ -72,4 +72,6 @@ jobs:
     - name: Test with pytest
       run: |
         export PYTHONPATH=$PYTHONPATH:.
+        # make sure pytest will use color in terminal output
+        export FORCE_COLOR="true"
         $POETRY_HOME/bin/poetry run pytest

Dockerfile

@@ -0,0 +1,52 @@
+# syntax=docker/dockerfile:1
+
+# base
+FROM python:3.12-slim-bookworm AS base
+ARG POETRY_VERSION="1.8.3"
+RUN adduser --disabled-login --gecos "" user
+USER user
+ENV PATH="${PATH}:/home/user/.local/bin/"
+WORKDIR /usr/src/app
+ENV POETRY_VERSION=${POETRY_VERSION}
+RUN pip install --upgrade setuptools pip && \
+    pip install --upgrade poetry==${POETRY_VERSION}
+COPY --chown=user:user application application/
+COPY --chown=user:user data data/
+COPY --chown=user:user poetry.lock pyproject.toml ./
+
+# test
+FROM base AS test
+USER user
+ENV PATH="${PATH}:/home/user/.local/bin/"
+WORKDIR /usr/src/app
+RUN poetry install --with test --no-root
+ENV PYTHONPATH="${PYTHONPATH}:/user/src/app"
+COPY --chown=user:user test test/
+# make sure pytest will use color in terminal output
+ENV FORCE_COLOR="true"
+CMD ["poetry", "run", "pytest"]
+
+# dev
+FROM test AS dev
+USER root
+RUN apt-get update && \
+    apt-get install git vim -y
+USER user
+ENV PATH="${PATH}:/home/user/.local/bin/"
+WORKDIR /usr/src/app
+COPY --chown=user:user .pre-commit-config.yaml ./
+RUN poetry install --with test,dev --no-root
+RUN git init . && \
+    poetry run pre-commit --version && \
+    poetry run pre-commit install
+ENV PYTHONPATH="${PYTHONPATH}:/user/src/app"
+CMD ["/bin/bash"]
+
+# run
+FROM base AS run
+USER user
+ENV PATH="${PATH}:/home/user/.local/bin/"
+WORKDIR /usr/src/app
+RUN poetry install --only main --no-root
+ENV PYTHONPATH="${PYTHONPATH}:/user/src/app"
+CMD ["poetry", "run", "python", "application/main.py"]

README.md

@@ -3,23 +3,24 @@
 Simple template for Python `3.12` with `pyenv`/`pyenv-virtualenv` and `poetry`.
 
 - [quickstart](#quickstart)
-- [pyenv/pyenv-virtualenv](#pyenvpyenv-virtualenv)
-- [poetry](#poetry)
+  - [pyenv/pyenv-virtualenv](#pyenvpyenv-virtualenv)
+  - [poetry](#poetry)
+  - [pre-comit](#pre-commit)
+- [docker](#docker)
 - [vagrant](#vagrant)
 - [reference](#reference)
 
 ## quickstart
 
-- clone the repo
-  ```shell
-  git clone git@github.com:markgreene74/python-template.git
-  ```
+### clone the repo
 
-## pyenv/pyenv-virtualenv
+```shell
+git clone git@github.com:markgreene74/python-template.git
+ ```
 
-TODO
-- make sure `pyenv` is installed
-- make sure `pyenv-virtualenv` is installed
+### pyenv/pyenv-virtualenv
+
+- make sure `pyenv` and `pyenv-virtualenv` are installed
 - install python `3.12`, for example `3.12.3`
   ```bash
   pyenv install 3.12.3
@@ -37,34 +38,60 @@ TODO
   pip install --upgrade pip setuptools
   ```
 
-## poetry
+### poetry
 
 - install poetry
   ```bash
   pip install --upgrade poetry==1.8.3
   ```
-- install the application runtime dependencies
-  ```bash
-  poetry install --only main
-  ```
-- install the application test dependencies
+- to install
+  - the application runtime dependencies
+    ```bash
+    poetry install --only main
+    ```
+  - the application test dependencies
+    ```bash
+    poetry install --with test
+    ```
+  - the application dev and test dependencies
+    ```bash
+    poetry install --with test,dev
+    ```
+  - the dependencies but not the current project
+    ```bash
+    poetry install --no-root --with test,dev
+    ```
+
+### pre-commit
+
+This project uses [`pre-commit`](https://pre-commit.com/).
+
+- install the hooks from the `.pre-commit-config.yaml` file
   ```bash
-  poetry install --with test
+  pre-commit install
   ```
-- install the application dev, test dependencies
-  ```bash
-  poetry install --with test,dev
+
+## docker
+
+- build the image
+  ```shell
+  docker build -t python-template .
   ```
-- install the dependencies but not the current project
-  ```bash
-  poetry install --no-root --with test,dev
+- run the container
+  ```shell
+  docker run -it --rm python-template
   ```
 
-## pre-commit
-
-This project use `pre-commit`. A `.pre-commit-config.yaml` is included.
+Intermediate stages (`test`, `dev`) are available in the `Dockerfile`. Build them with:
+```shell
+docker build -t python-template . --target <stage>
+```
 
-Run `pre-commit install` to install the Git hooks.
+For example, build and tun the tests with:
+```shell
+docker build -t python-template . --target test && \
+  docker run -it --rm python-template
+```
 
 ## vagrant
 

application/main.py

@@ -1,5 +1,7 @@
 import datetime as dt
 
+from rich import print as rp
+
 import application.helpers.helpers_main as hlp_m
 
 # variables
@@ -8,7 +10,7 @@
 # main function goes here
 def main() -> dt.datetime:
     _now = hlp_m.get_timestamp()
-    print(f"The current datetime is: {_now}")
+    rp(f"The current datetime is: [bold magenta]{_now}[/bold magenta]")
 
     # just return the timestamp for now, so we have something to test
     return _now

poetry.lock

@@ -8,6 +8,7 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.12"
+rich = "^13.9.2"
 
 
 [tool.poetry.group.test.dependencies]

pyproject.toml

@@ -16,4 +16,5 @@ def test_main_output(capsys):
     main.main()
     out, err = capsys.readouterr()
     assert MAIN_MSG in out
+    assert "\x1b[1;35m" in out  # the output contains colours
     assert err == ""