Merge pull request #3 from NitorCreations/docker

Add Docker support

Author: Jalle19

Dockerfile

@@ -0,0 +1,12 @@
+FROM python:3.13
+
+WORKDIR /app
+
+COPY pyproject.toml vinx_mjpeg_server.py /app
+COPY vinx_mjpeg_server /app/vinx_mjpeg_server
+
+RUN pip install --no-cache .
+
+ENTRYPOINT ["python3", "/app/vinx_mjpeg_server.py"]
+
+CMD ["-h"]

README.md

@@ -15,6 +15,33 @@ there was an issue in fetching the preview image.
 This application uses our [pylw3](https://github.com/NitorCreations/pylw3) library under the hood to discover encoders 
 and [aiohttp](https://github.com/aio-libs/aiohttp) for HTTP.
 
+## Usage
+
+The recommended way is to run the server using the supplied Dockerfile:
+
+```bash
+$ docker build -t vinx-mjpeg-server:latest .
+$ docker run vinx-mjpeg-server:latest -h
+DEBUG:asyncio:Using selector: EpollSelector
+usage: vinx-mjpeg-server [-h] --bootstrap-node BOOTSTRAP_NODE
+                         [--fallback-image FALLBACK_IMAGE] [-l LISTEN_ADDRESS]
+                         [-p PORT]
+
+Serves MJPEG streams from VINX HDMI encoder preview images
+
+options:
+  -h, --help            show this help message and exit
+  --bootstrap-node BOOTSTRAP_NODE
+                        A VINX encoder to use as bootstrap node for auto-
+                        discovery
+  --fallback-image FALLBACK_IMAGE
+                        A JPEG image to use as fallback when the encoder
+                        preview is unavailable
+  -l, --listen-address LISTEN_ADDRESS
+                        The address the HTTP server should listen on
+  -p, --port PORT       The port the HTTP should listen on
+```
+
 ## License
 
 GNU GENERAL PUBLIC LICENSE version 3

pyproject.toml

@@ -10,6 +10,8 @@ dependencies = [
     "aiohttp"
 ]
 
+[tool.setuptools]
+py-modules = ["vinx-mjpeg-server"]
 
 [tool.ruff]
 # https://github.com/astral-sh/ruff#configuration

vinx_mjpeg_server.py

@@ -6,7 +6,7 @@
 from aiohttp import web
 
 from vinx_mjpeg_server.encoder import discover_encoders
-from vinx_mjpeg_server.http import HttpRequestHandler
+from vinx_mjpeg_server.server import HttpRequestHandler
 
 logging.basicConfig(level=logging.DEBUG)
 logger = logging.getLogger("vinx_mjpeg_server")
@@ -23,8 +23,9 @@ async def main():
     parser.add_argument(
         "--fallback-image", help="A JPEG image to use as fallback when the encoder preview is unavailable"
     )
-    parser.add_argument("-l", "--listen-address", default="0.0.0.0",
-                        help="The address the HTTP server should listen on")
+    parser.add_argument(
+        "-l", "--listen-address", default="0.0.0.0", help="The address the HTTP server should listen on"
+    )
     parser.add_argument("-p", "--port", default=6180, type=int, help="The port the HTTP should listen on")
     args = parser.parse_args()