initial setup

Author: tedivm

.dockerignore

@@ -0,0 +1,4 @@
+# Ignore everything
+**
+
+!/assets/*

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/image-build.yml

@@ -0,0 +1,41 @@
+name: TEMPLATE_PYTHON_PACKAGE Image Builder
+
+on:
+  push:
+    branches:
+      - "CHANGEME"
+    paths-ignore:
+      - "**/README.md"
+      - "templates/**"
+      - ".github/workflows/versionator.yml"
+  schedule:
+    - cron: "4 0 * * WED"
+
+jobs:
+  Uvicorn-Builder:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python_versions: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        package_versions: ["0.4.2"]
+        target_base: ["full", "slim", "alpine"]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: "Create and push"
+        uses: multi-py/action-python-image-builder@main
+        with:
+          package: "quasiqueue"
+          package_latest_version: "0.4.2"
+          maintainer: "Robert Hafner <tedivm@tedivm.com>"
+          python_version: ${{ matrix.python_versions }}
+          target_base: ${{ matrix.target_base }}
+          package_version: ${{ matrix.package_versions }}
+          registry_password: ${{ secrets.GITHUB_TOKEN }}
+          platform: "linux/amd64,linux/arm64"
+
+          # Uncomment to use local docker files instead of action ones.
+          #dockerfile: "${{ github.workspace }}/dockerfile"
+          #docker_build_path: "${{ github.workspace }}/"

.github/workflows/versionator.yml

@@ -0,0 +1,30 @@
+name: TEMPLATE_PYTHON_PACKAGE Version Updater
+
+# Every 30 minutes check for a new version of the package.
+on:
+  push:
+    branches:
+      - "main"
+    # Don't self-trigger
+    paths-ignore:
+      - "**/README.md"
+      - ".github/workflows/image-build.yml"
+  schedule:
+    - cron: "0,30 * * * *"
+
+jobs:
+  Version-Updater:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.WORKFLOW_GITHUB_TOKEN }}
+
+      - name: "Update Builder"
+        uses: multi-py/action-python-versionator@main
+        with:
+          package: "quasiqueue"
+          git_name: "Robert Hafner"
+          git_email: "tedivm@tedivm.com"
+          action_path: ${{ github.workspace }}/.github/workflows/image-build.yml

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Robert Hafner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,157 @@
+# multipy-image-template
+
+<!--ts-->
+<!--te-->
+
+## Benefits
+
+### Multi Architecture Builds
+
+Every tag in this repository supports these architectures:
+
+* linux/amd64
+* linux/arm64
+* linux/arm/v7
+
+
+### Small Images via Multi Stage Builds
+
+All libraries are compiled in one image before being moved into the final published image. This keeps all of the build tools out of the published container layers.
+
+### No Rate Limits
+
+This project uses the Github Container Registry to store images, which have no rate limiting on pulls (unlike Docker Hub).
+
+### Rapid Building of New Versions
+
+Within 30 minutes of a new release to TEMPLATE_PYTHON_PACKAGE on PyPI builds will kick off for new containers. This means new versions can be used in hours, not days.
+
+### Regular Updates
+
+Containers are rebuilt weekly in order to take on the security patches from upstream containers.
+
+## How To
+
+### Full
+
+To pull the latest slim version:
+
+```bash
+docker pull ghcr.io/multi-py/multipy-image-template:py3.10-LATEST
+```
+
+To include it in the dockerfile instead:
+
+```dockerfile
+FROM ghcr.io/multi-py/multipy-image-template:py3.10-LATEST
+```
+
+### Slim
+
+To pull the latest slim version:
+
+```bash
+docker pull ghcr.io/multi-py/multipy-image-template:py3.10-slim-LATEST
+```
+
+To include it in the dockerfile instead:
+
+```dockerfile
+FROM ghcr.io/multi-py/multipy-image-template:py3.10-slim-LATEST
+```
+
+### Copy Just the Packages
+
+It's also possible to copy just the Python packages themselves. This is particularly useful when you want to use the precompiled libraries from multiple containers.
+
+```dockerfile
+FROM python:3.10
+
+COPY --from=ghcr.io/multi-py/multipy-image-template:py3.10-slim-LATEST /usr/local/lib/python3.10/site-packages/* /usr/local/lib/python3.10/site-packages/
+```
+
+
+
+## Python Versions
+
+This project actively supports these Python versions:
+
+* 3.10
+* 3.9
+* 3.8
+* 3.7
+* 3.6
+
+
+## Image Variants
+
+Like the upstream Python containers themselves a variety of image variants are supported.
+
+
+### Full
+
+The default container type, and if you're not sure what container to use start here. It has a variety of libraries and build tools installed, making it easy to extend.
+
+
+
+### Slim
+
+This container is similar to Full but with far less libraries and tools installed by default. If yo're looking for the tiniest possible image with the most stability this is your best bet.
+
+
+
+### Alpine
+
+This container is provided for those who wish to use Alpine. Alpine works a bit differently than the other image types, as it uses `musl` instead of `glibc` and many libaries are not well tested under `musl` at this time.
+
+
+
+## Architectures
+
+Every tag in this repository supports these architectures:
+
+* linux/amd64
+* linux/arm64
+* linux/arm/v7
+
+
+## Sponsorship
+
+If you get use out of these containers please consider sponsoring me using Github!
+<center>
+
+[![Github Sponsorship](https://raw.githubusercontent.com/mechPenSketch/mechPenSketch/master/img/github_sponsor_btn.svg)](https://github.com/sponsors/tedivm)
+
+</center>
+
+## Tags
+
+* Recommended Image: `ghcr.io/multi-py/multipy-image-template:py3.10-0.1.1`
+* Slim Image: `ghcr.io/multi-py/multipy-image-template:py3.10-slim-0.1.1`
+
+Tags are based on the package version, python version, and the upstream container the container is based on.
+
+| TEMPLATE_PYTHON_PACKAGE Version | Python Version | Full Container | Slim Container | Alpine Container |
+|-----------------------|----------------|----------------|----------------|------------------|
+| latest | 3.10 | py3.10-latest | py3.10-slim-latest | py3.10-alpine-latest |
+| latest | 3.9 | py3.9-latest | py3.9-slim-latest | py3.9-alpine-latest |
+| latest | 3.8 | py3.8-latest | py3.8-slim-latest | py3.8-alpine-latest |
+| latest | 3.7 | py3.7-latest | py3.7-slim-latest | py3.7-alpine-latest |
+| latest | 3.6 | py3.6-latest | py3.6-slim-latest | py3.6-alpine-latest |
+| 0.1.1 | 3.10 | py3.10-0.1.1 | py3.10-slim-0.1.1 | py3.10-alpine-0.1.1 |
+| 0.1.1 | 3.9 | py3.9-0.1.1 | py3.9-slim-0.1.1 | py3.9-alpine-0.1.1 |
+| 0.1.1 | 3.8 | py3.8-0.1.1 | py3.8-slim-0.1.1 | py3.8-alpine-0.1.1 |
+| 0.1.1 | 3.7 | py3.7-0.1.1 | py3.7-slim-0.1.1 | py3.7-alpine-0.1.1 |
+| 0.1.1 | 3.6 | py3.6-0.1.1 | py3.6-slim-0.1.1 | py3.6-alpine-0.1.1 |
+| 0.1.0 | 3.10 | py3.10-0.1.0 | py3.10-slim-0.1.0 | py3.10-alpine-0.1.0 |
+| 0.1.0 | 3.9 | py3.9-0.1.0 | py3.9-slim-0.1.0 | py3.9-alpine-0.1.0 |
+| 0.1.0 | 3.8 | py3.8-0.1.0 | py3.8-slim-0.1.0 | py3.8-alpine-0.1.0 |
+| 0.1.0 | 3.7 | py3.7-0.1.0 | py3.7-slim-0.1.0 | py3.7-alpine-0.1.0 |
+| 0.1.0 | 3.6 | py3.6-0.1.0 | py3.6-slim-0.1.0 | py3.6-alpine-0.1.0 |
+
+
+### Older Tags
+
+Older tags are left for historic purposes but do not receive updates. A full list of tags can be found on the package's [registry page](https://github.com/multi-py/multipy-image-template/pkgs/container/multipy-image-template).
+
+

assets/main.py

@@ -0,0 +1,30 @@
+import asyncio
+
+from quasiqueue import QuasiQueue
+
+
+async def writer(desired: int):
+  """Feeds data to the Queue when it is low.
+  """
+  for x in range(0, desired):
+    yield x
+
+
+
+async def reader(identifier: int|str):
+  """Receives individual items from the queue.
+
+  Args:
+      identifier (int | str): Comes from the output of the Writer function
+  """
+  print(f"{identifier}")
+
+
+runner = QuasiQueue(
+  "hello_world",
+  reader=reader,
+  writer=writer,
+)
+
+if __name__ == '__main__':
+  asyncio.run(runner.main())

assets/start.sh

@@ -0,0 +1,34 @@
+#! /usr/bin/env bash
+set -e
+
+#
+# The follow block comes from tiangolo/uvicorn-gunicorn-docker
+# MIT License: https://github.com/tiangolo/uvicorn-gunicorn-docker/blob/master/LICENSE
+#
+
+if [ -f /app/app/main.py ]; then
+    DEFAULT_MODULE_NAME=app.main
+elif [ -f /app/main.py ]; then
+    DEFAULT_MODULE_NAME=main
+fi
+MODULE_NAME=${MODULE_NAME:-$DEFAULT_MODULE_NAME}
+
+# If there's a prestart.sh script in the /app directory or other path specified, run it before starting
+PRE_START_PATH=${PRE_START_PATH:-/app/prestart.sh}
+echo "Checking for script in $PRE_START_PATH"
+if [ -f $PRE_START_PATH ]; then
+    echo "Running script $PRE_START_PATH"
+    . "$PRE_START_PATH"
+else
+    echo "There is no script $PRE_START_PATH"
+fi
+
+#
+# End of tiangolo/uvicorn-gunicorn-docker block
+#
+
+if [[ $RELOAD == "true" ]]; then
+    watchfiles "exec python -m $MODULE_NAME" /app
+else
+    exec python -m "$MODULE_NAME"
+fi

dockerfile

@@ -0,0 +1,48 @@
+ARG python_version=3.9
+ARG build_target=$python_version
+ARG publish_target=$python_version
+
+FROM python:$build_target as Builder
+
+# Add arguments to container scope
+ARG build_target
+ARG package
+ARG package_version
+
+# Only add build tools for alpine image. The ubuntu based images have build tools already.
+# Only runs if `apk` is on the system.
+RUN if which apk ; then apk add python3-dev libffi-dev libevent-dev build-base bash cargo rust gcc musl-dev maturin; fi
+
+# Install packaer and build all dependencies.
+RUN pip install $package==$package_version watchfiles
+
+
+# Build our actual container now.
+FROM python:$publish_target
+
+# Add args to container scope.
+ARG publish_target
+ARG python_version
+ARG package
+ARG maintainer=""
+ARG TARGETPLATFORM=""
+LABEL python=$python_version
+LABEL package=$package
+LABEL maintainer=$maintainer
+LABEL org.opencontainers.image.description="python:$publish_target $package:$package_version $TARGETPLATFORM"
+
+
+# Copy all of the python files built in the Builder container into this smaller container.
+COPY --from=Builder /usr/local/lib/python$python_version /usr/local/lib/python$python_version
+
+# Startup Script
+COPY ./assets/start.sh /start.sh
+RUN chmod +x /start.sh
+
+# Example application so container "works" when run directly.
+COPY ./assets/main.py /app/main.py
+WORKDIR /app/
+
+ENV PYTHONPATH=/app
+
+CMD ["/start.sh"]

templates/description.md

@@ -0,0 +1,3 @@
+A multiarchitecture container image for running Python with [QuasiQueue](https://github.com/tedivm/quasiqueue).
+
+Looking for the containers? [Head over to the Github Container Registry](https://github.com/multi-py/python-uvicorn/pkgs/container/python-quasiqueue)!