Add support for Docker

.github/workflows/github-image.yml

@@ -0,0 +1,52 @@
+name: Github Registry
+
+on:
+  push:
+    branches: 
+      - '**'
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:          
+  build:
+    name: Push Docker Image to Github Registry
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Setup Docker buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3.0.0
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@31cebacef4805868f9ce9a0cb03ee36c32df2ac4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@4a13e500e55cf31b7a5d59a38ab2040ab0f42f56
+        with:
+          context: ./docker/
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

README.rst

@@ -60,6 +60,12 @@ Alternatively, the tool can be installed with ``git``:
    $ cd chat-downloader
    $ python setup.py install
 
+The tool can be used with ``docker``:
+
+.. code:: console
+
+   $ docker run -v /path/to/download/:/home/download/ -e channelURL='https://www.twitch.tv/twitch' -e channelName='twitch' -e fileFormat='json' -e uid='1000' -e gid='1000' ghcr.io/xenova/chat-downloader:master
+
 
 #####
 Usage
@@ -118,6 +124,19 @@ Python
 For advanced python use-cases and examples, consult the `Python Documentation <https://chat-downloader.readthedocs.io/en/latest/source/index.html#python-documentation>`_.
 
 
+Docker
+------
+
+- **/home/download** - the place where the file will be saved. Mount it to a desired place with -v option.
+- **channelURL** - the url of the stream you want to record.
+- **channelName** - the name for the stream.
+- **fileFormat** - file extension to be used.
+- **uid** - UserID, map to your desired User ID (fallback to 9001)
+- **gid** - GroupID, map to your desired Group ID (fallback to 9001)
+
+The File will be saved as channelName-YearMonthDate-HourMinuteSecond.ext
+
+
 ##########
 Chat Items
 ##########

docker/Dockerfile

@@ -0,0 +1,24 @@
+FROM python:3.12
+LABEL maintainer="lauwarm@mailbox.org"
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install gosu -y
+
+COPY requirements.txt /app/
+RUN pip install --no-cache-dir -r requirements.txt
+
+RUN  echo 'export PATH="${HOME}/.local/bin:${PATH}"'
+
+COPY . /app
+
+RUN mkdir /home/download
+RUN mkdir /home/script
+
+COPY ./entrypoint.sh /home/script/
+
+RUN ["chmod", "+x", "/home/script/entrypoint.sh"]
+
+ENTRYPOINT [ "/home/script/entrypoint.sh" ]
+
+CMD python download_chat.py ${channelURL} ${channelName} ${fileFormat}

docker/download_chat.py

@@ -0,0 +1,11 @@
+import subprocess, sys
+from datetime import datetime
+
+channel_url = sys.argv[1]
+channel_name = sys.argv[2]
+file_format = sys.argv[3]
+
+now = datetime.now()
+d1 = now.strftime("%Y%m%d-%H%M%S")
+
+subprocess.run(['chat_downloader', channel_url, '--output', "/home/download/"+channel_name+"-"+d1+'.'+file_format])

docker/entrypoint.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+# Add local user and group
+# Either use the uid and gid if passed in at runtime or
+# fallback to 9001
+
+USER_ID=${uid:-9001}
+GROUP_ID=${gid:-9001}
+
+echo "UID : $USER_ID \nGID : $GROUP_ID"
+
+chown -R $USER_ID:$GROUP_ID /home/script
+
+exec gosu $USER_ID "$@"

docker/requirements.txt

@@ -0,0 +1 @@
+chat-downloader==0.2.8

docs/README.rst

@@ -60,6 +60,11 @@ Alternatively, the tool can be installed with ``git``:
    $ cd chat-downloader
    $ python setup.py install
 
+The tool can be used with ``docker``:
+
+.. code:: console
+
+   $ docker run -v /path/to/download/:/home/download/ -e channelURL='https://www.twitch.tv/twitch' -e channelName='twitch' -e fileFormat='json' -e uid='1000' -e gid='1000' ghcr.io/xenova/chat-downloader:master
 
 #####
 Usage
@@ -99,6 +104,26 @@ Python
 For advanced python use-cases and examples, consult the :ref:`Python Documentation`.
 
 
+Docker
+------
+
+.. code:: console
+
+    /home/download - the place where the file will be saved. Mount it to a desired place with -v option.
+
+    channelURL - the url of the stream you want to record.
+
+    channelName - the name for the stream.
+
+    fileFormat - file extension to be used.
+
+    uid - UserID, map to your desired User ID (fallback to 9001)
+
+    gid - GroupID, map to your desired Group ID (fallback to 9001)
+
+
+The File will be saved as streamName-YearMonthDate-HourMinuteSecond.ext
+
 ##########
 Chat Items
 ##########