Merge pull request #4 from Polymathian/add-sharpei-to-docker

Add Sharpei to Docker Hub

.github/workflows/push-to-docker.yml

@@ -0,0 +1,40 @@
+name: Push to Docker
+
+on:
+    release:
+        types: [published]
+
+jobs:
+    docker-push:
+        runs-on: ubuntu-latest
+        env:
+            DOCKER_BUILDKIT: 1
+            VERSION: ${{github.event.release.tag_name}}
+
+        steps:
+            - name: Set version string
+              id: vars
+              run: echo ::set-output name=release_version::${VERSION##*v}
+
+            - name: Set up QEMU
+              uses: docker/setup-qemu-action@v1
+
+            - name: Set up Docker Buildx
+              uses: docker/setup-buildx-action@v1
+
+            - name: Login to DockerHub
+              uses: docker/login-action@v1
+              with:
+                  username: ${{ secrets.DOCKERHUB_USERNAME }}
+                  password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+            - name: Docker Build and Push
+              uses: docker/build-push-action@v2
+              with:
+                  context: .
+                  file: ./Dockerfile
+                  platforms: linux/amd64,linux/arm64,linux/386
+                  push: true
+                  tags: |
+                      polymathian/sharpei:latest
+                      polymathian/sharpei:${{ steps.vars.outputs.release_version }}

Dockerfile

@@ -0,0 +1,9 @@
+FROM python:3.9-slim-buster
+
+COPY . /app
+WORKDIR /app
+
+RUN mkdir /data
+RUN pip3 install -e .
+
+ENTRYPOINT [ "sharpei",  "/data"]

README.md

@@ -6,16 +6,46 @@ Requires Python 3.6+
 
 ## Usage
 
+Sharpei can be run from the CLI or Docker.
+
+#### CLI
+
 Install from [PyPI](https://pypi.org/project/sharpei/)
 
 ```bash
 pip install sharpei
 ```
 
-#### CLI
+To run:
+
 ```bash
 # Monitor the current directory and send all files
 > sharpei . s3://bucket/key-prefix/
 ```
 
 Use `sharpei --help` to discover additional options
+
+#### Docker
+
+You will need to mount a directory to the Docker image as `/data`.
+
+```bash
+> docker run --mount type=bind,source=YOUR_DIRECTORY,target=/data sharpei s3://bucket/key-prefix
+```
+
+For example, given a folder structure:
+
+```
+working-dir
+│   README.md
+|
+└───target-folder
+        file011.txt
+        file012.txt
+```
+
+To monitor file changes in `target-folder`, run:
+
+```bash
+> docker run --mount type=bind,source="$(pwd)"/target-folder,target=/data polymathian/sharpei s3://my-bucket/my-prefix
+```