Add Docker image for the CLI

.github/workflows/docker-publish.yml

@@ -0,0 +1,40 @@
+name: Publish docker image
+on:
+  push:
+    branches: ['main']
+    tags: [v*]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+        base: ["", "-alpine", "-slim"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Calculate version
+        id: get_version
+        run: |
+          VERSION=$(git describe --tags | sed "s/^v//")
+          echo "VERSION=$VERSION" >> "$GITHUB_OUTPUT"
+          echo $VERSION
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: |
+            ghcr.io/${{ github.repository }}:${{ steps.get_version.outputs.VERSION }}${{ matrix.base }}
+            ghcr.io/${{ github.repository }}:latest${{ matrix.base }}
+          build-args: |
+            IMAGE=python:${{ matrix.python-version }}${{ matrix.base }}

Dockerfile

@@ -0,0 +1,26 @@
+ARG IMAGE=python:3.11-alpine
+
+FROM $IMAGE as builder
+
+RUN pip install poetry==1.5.1
+
+ENV POETRY_NO_INTERACTION=1 \
+    POETRY_VIRTUALENVS_IN_PROJECT=1 \
+    POETRY_VIRTUALENVS_CREATE=1 \
+    POETRY_CACHE_DIR=/tmp/poetry_cache
+
+WORKDIR /app
+
+COPY . /app
+
+RUN poetry install --without dev --without lsp
+
+FROM $IMAGE as runtime
+
+ENV VIRTUAL_ENV=/app/.venv \
+    PATH="/app/.venv/bin:$PATH"
+
+COPY --from=builder ${VIRTUAL_ENV} ${VIRTUAL_ENV}
+COPY . /app
+
+ENTRYPOINT ["keymap"]

README.md

@@ -48,6 +48,12 @@ keymap --help
 Alternatively, you can `pip install keymap-drawer` in a virtual environment or install into your user install directory with `pip install --user keymap-drawer`.
 See [the development section](#development) for instructions to install from source.
 
+### Using docker
+
+``` sh
+docker pull ghcr.io/hnaderi/keymap-drawer:latest
+```
+
 ### Bootstrapping your keymap representation
 
 **`keymap parse`** command helps to parse an existing QMK or ZMK keymap file into the keymap YAML representation the `draw` command uses to generate SVGs.