Merge pull request #64 from getindata/dockerfile

Dockerfile for development

.github/workflows/python-package.yml

@@ -43,3 +43,9 @@ jobs:
       - name: Wheel
         run: |
           python setup.py sdist
+
+      - name: Build docker image
+        uses: docker/build-push-action@v3
+        with:
+          push: false
+          tags: getindata/streaming-jupyter-integrations:latest

Dockerfile

@@ -0,0 +1,50 @@
+FROM jupyter/base-notebook:python-3.8.8
+
+WORKDIR /app/
+
+USER $NB_USER
+
+RUN python -V
+RUN python -m pip install virtualenv pipdeptree
+
+USER root
+
+RUN ["/bin/bash", "-c", "python -m venv venv"]
+
+USER $NB_USER
+
+RUN ["/bin/bash", "-c", "source venv/bin/activate"]
+RUN ["/bin/bash", "-c", "pip install --upgrade pip"]
+
+USER root
+
+RUN apt update && apt-get install -y software-properties-common curl wget yarn
+RUN apt-add-repository ppa:openjdk-r/ppa
+RUN apt-get update && \
+    apt-get install -y openjdk-11-jdk
+
+USER $NB_USER
+
+RUN wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash
+RUN source ~/.nvm/nvm.sh && \
+    nvm install node 19.0.1
+
+RUN pip install jupyterlab-lsp "nbclassic>=0.2.8"
+
+COPY requirements.txt ./
+RUN pip install -r requirements.txt
+
+USER root
+
+COPY . ./
+RUN chown $NB_USER ./
+RUN source ~/.nvm/nvm.sh && \
+    pip install .
+
+USER $NB_USER
+
+ENV JUPYTER_ENABLE_LAB=yes
+ENV FLINK_HOME=/opt/conda/lib/python3.8/site-packages/pyflink
+
+RUN chown -R $NB_USER:users $FLINK_HOME
+USER $NB_USER

README.md

@@ -181,6 +181,27 @@ the pipeline does not end with `.execute()`, the execution is triggered by the J
 
 ## Local development
 
+There are currently 2 options for running `streaming_jupyter_integrations` for development. We can either
+use a Docker image or install it on our machine.
+
+### Docker image
+
+You can build a `Docker` image of `Jupyter Notebooks` by running the command below.
+It will contain functionality that was developed in this project.
+```bash
+docker build --tag streaming_jupyter_integrations_image .
+```
+
+After the image is built, we can run it using this command.
+```bash
+docker run --name streaming_jupyter_integrations -p 8888:8888 streaming_jupyter_integrations_image
+```
+
+After that we should be able to reach our Jupyterhub running on Docker under:
+http://127.0.0.1:8888/
+
+### Local installation
+
 Note: You will need NodeJS to build the extension package.
 
 The `jlpm` command is JupyterLab's pinned version of
@@ -200,6 +221,8 @@ jupyter labextension develop . --overwrite
 jlpm build
 ```
 
+### pre-commit
+
 The project uses [pre-commit](https://pre-commit.com/) hooks to ensure code quality, mostly by linting.
 To use it, [install pre-commit](https://pre-commit.com/#install) and then run
 ```shell