Add docker to getting started (#470)

.github/workflows/pkg.yml

@@ -25,11 +25,7 @@ jobs:
         password = ${{ secrets.TEST_PYPI_TOKEN }}
         EOM
     - run: poetry run twine upload --repository pypi dist/*
-
-  docker:
-    runs-on: ubuntu-18.04
-    steps:
-      - uses: actions/checkout@v2
-      - run: docker login --username ${{ secrets.DOCKER_USERNAME }} --password ${{ secrets.DOCKER_PASSWORD }}
-      - run: docker build . -t "hlambdas/human-lambdas:${GITHUB_REF:10}"
-      - run: docker push "hlambdas/human-lambdas:${GITHUB_REF:10}"
+    - run: docker login --username ${{ secrets.DOCKER_USERNAME }} --password ${{ secrets.DOCKER_PASSWORD }}
+    - run: docker tag "hlambdas/human-lambdas:latest" "hlambdas/human-lambdas:${GITHUB_REF:10}" # e.g. :v1.0.44
+    - run: docker tag "hlambdas/human-lambdas:latest" "hlambdas/human-lambdas:${GITHUB_REF:10:12}" # e.g. :v1
+    - run: docker push -a "hlambdas/human-lambdas"

.github/workflows/test-publish.yml

@@ -14,6 +14,10 @@ jobs:
       - run: |
           export LDFLAGS='-I/usr/local/opt/openssl/include -L/usr/local/opt/openssl/lib'
           make
+      - run: |
+          export LDFLAGS='-I/usr/local/opt/openssl/include -L/usr/local/opt/openssl/lib'
+          pip install dist/*whl
+      - run: hl initdb # check package installs and run
       - uses: pre-commit/action@v2.0.0
         with:
           extra_args: --verbose --all-files
@@ -28,15 +32,6 @@ jobs:
           password = ${{ secrets.TEST_PYPI_TOKEN }}
           EOM
       - run: poetry run twine upload --repository testpypi dist/*
-      - run: |
-          export LDFLAGS='-I/usr/local/opt/openssl/include -L/usr/local/opt/openssl/lib'
-          pip install dist/*whl
-      - run: hl initdb # check package installs and run
-
-  docker:
-    runs-on: ubuntu-18.04
-    steps:
-      - uses: actions/checkout@v2
       - run: docker login --username ${{ secrets.DOCKER_USERNAME }} --password ${{ secrets.DOCKER_PASSWORD }}
-      - run: docker build . -t "hlambdas/human-lambdas:$GITHUB_SHA"
-      - run: docker push "hlambdas/human-lambdas:$GITHUB_SHA"
+      - run: docker tag "hlambdas/human-lambdas:latest" "hlambdas/human-lambdas:$GITHUB_SHA"
+      - run: docker push "hlambdas/human-lambdas:$GITHUB_SHA"

Dockerfile

@@ -1,16 +1,8 @@
-FROM python:3
 
-ENV PYTHONUNBUFFERED 1
-
-RUN mkdir /code
-WORKDIR /code
-COPY pyproject.toml /code/
-COPY poetry.lock /code/
-RUN pip install poetry && poetry config virtualenvs.create false
-RUN poetry install
-
-COPY . /code/
-RUN poetry install
+FROM python:3.8
 
+# requires poetry build before docker build
+COPY dist/human_lambdas*whl human-lambdas-0.0.0-py3-none-any.whl
+RUN pip install human-lambdas-0.0.0-py3-none-any.whl
 EXPOSE 8000
-ENTRYPOINT [ "human-lambdas" ]
+ENTRYPOINT "bash"

Makefile

@@ -1,3 +1,5 @@
+buildimg: buildpy
+	docker build . -t hlambdas/human-lambdas:latest
 buildpy: buildweb
 	poetry install
 	poetry build

README.md

@@ -27,14 +27,22 @@ It is designed to provide an **all-in-one solution to build, operate and monitor
 
 We are going to run Human Lambdas on a developer device.
 
-Please ensure you have Python 3 installed on a Mac or Linux environment then run the following.
+Please ensure you have Docker installed.
 
 ```sh
-export LDFLAGS='-I/usr/local/opt/openssl/include -L/usr/local/opt/openssl/lib' # for psycopg2 on OS X
-pip install human-lambdas
+mkdir .human_lambdas # create data directory
+
+docker run \
+  -p 8000:8000 \
+  -it \
+  --rm \
+  -v $(pwd)/.human_lambdas:/.human_lambdas \
+  hlambdas/human-lambdas:v1
 ```
 
-Now initialize a sqlite database in a local `.human_lambdas` directory.
+A shell should eventually start inside the container.
+
+Now initialize a sqlite database in your .human_lambdas dir
 
 ```sh
 human-lambdas initdb
@@ -86,12 +94,7 @@ export POSTGRES_PASSWORD=some_password
 
 docker run \
   -p 8000:8000 \
-  -e "POSTGRES_HOST=$POSTGRES_HOST" \
-  -e "POSTGRES_PORT=$POSTGRES_PORT" \
-  -e "POSTGRES_USER=$POSTGRES_USER" \
-  -e "POSTGRES_PASSWORD=$POSTGRES_PASSWORD" \
-  -e "POSTGRES_DB=$POSTGRES_DB" \
-  --entrypoint=bash \
+  -v $(pwd)/.human_lambdas:/.human_lambdas \
   hlambdas/human-lambdas:latest \
   -c 'hl initdb && hl up'
 ```
@@ -101,4 +104,12 @@ Human Lambdas is now available on localhost:8000.
 This approach lets you use Human Lambdas in stateless environments such as Google Cloud Run as long as
 
 1. You do not run `initdb` on startup, as it is not thread-safe
-2. You set a single `SECRET_KEY` environment variable so that all Django Invite/Session tokens work
+2. You set a single `SECRET_KEY` environment variable so that all Django Invite/Session tokens work
+
+## Directly install Python Package
+
+Requires Python 3.
+
+```sh
+pip install human-lambdas
+```