configure deployment on playground with circleCI (#19)

* configure deployment on playground with circleCI

Author: emmanuelle

.circleci/config.yml

@@ -0,0 +1,51 @@
+version: 2.0
+
+jobs:
+  deploy_to_playground:
+    docker:
+      - image: circleci/python:3.6-stretch
+    steps:
+      - checkout
+      - run:
+          name: Add plotly remote
+          command: git remote add playground https://dash-playground.plotly.host/GIT/slicer-$CIRCLE_BRANCH
+      - run:
+          name: Create helper-script
+          command: printf '#!/bin/bash\necho username=$PLAYGROUND_DEPLOY_USERNAME\necho password=$PLAYGROUND_DEPLOY_PASSWORD' >> /home/circleci/helper-script.sh
+      - run:
+          name: Set up git config
+          command: |
+            git config --global credential.helper "/bin/bash /home/circleci/helper-script.sh"
+            git config --global user.email '<>' # Leave email blank
+            git config --global user.name "Circle MonoRepo Automatic Deployer"
+      - run:
+          name: Install curl
+          command: |
+            sudo apt update
+            sudo apt install -y -qq curl
+      - run:
+          name: Install dds-client
+          command: |
+            curl -sSL -o dds-client.tgz https://github.com/plotly/dds-client/releases/download/v0.3.0/dds-client_0.3.0_linux_x86_64.tgz
+            mkdir $HOME/bin
+            tar xzf dds-client.tgz -C $HOME/bin
+            chmod +x $HOME/bin/dds-client
+      - run:
+          name: Deploy
+          command: |
+            if ! DASH_ENTERPRISE_URL="$DASH_PLAYGROUND_ENTERPRISE_URL" DASH_ENTERPRISE_API_KEY="$DASH_PLAYGROUND_ENTERPRISE_API_KEY" DASH_ENTERPRISE_USERNAME="$PLAYGROUND_DEPLOY_USERNAME" dds-client apps:exists --name "slicer-$CIRCLE_BRANCH" >/dev/null 2>&1; then
+              DASH_ENTERPRISE_URL="$DASH_PLAYGROUND_ENTERPRISE_URL" DASH_ENTERPRISE_API_KEY="$DASH_PLAYGROUND_ENTERPRISE_API_KEY" DASH_ENTERPRISE_USERNAME="$PLAYGROUND_DEPLOY_USERNAME" dds-client apps:create --name "slicer-$CIRCLE_BRANCH"
+            fi
+            # We force push since branches can diverge and playground is a
+            # sandbox
+            git push --force playground $CIRCLE_BRANCH:master
+
+workflows:
+  version: 2
+  test-and-deploy:
+    jobs:
+      - deploy_to_playground:
+          filters:
+            branches:
+              ignore:
+              - main

Procfile

@@ -0,0 +1 @@
+web: gunicorn test_deploy.app:server

README.md

@@ -45,3 +45,7 @@ This code is distributed under MIT license.
 * Use `black .` to autoformat.
 * Use `flake8 .` to lint.
 * Use `pytest .` to run the tests.
+
+On every PR, an app with the same name as your branch is deployed to the Dash
+playground instance so that you can change whether your changes did not break
+the package.

app.json

@@ -0,0 +1,7 @@
+{
+    "scripts": {
+        "dokku": {
+            "predeploy": "python test_deploy/predeploy.py"
+        }
+    }
+}

test_deploy/app.py

@@ -0,0 +1,47 @@
+"""
+An example with two slicers on the same volume.
+"""
+
+import dash
+import dash_html_components as html
+from dash_slicer import VolumeSlicer
+import imageio
+
+
+app = dash.Dash(__name__)
+server = app.server
+
+vol = imageio.volread("imageio:stent.npz")
+slicer1 = VolumeSlicer(app, vol, axis=1)
+slicer2 = VolumeSlicer(app, vol, axis=2)
+
+app.layout = html.Div(
+    style={
+        "display": "grid",
+        "gridTemplateColumns": "40% 40%",
+    },
+    children=[
+        html.Div(
+            [
+                html.H1("Coronal"),
+                slicer1.graph,
+                html.Br(),
+                slicer1.slider,
+                *slicer1.stores,
+            ]
+        ),
+        html.Div(
+            [
+                html.H1("Sagittal"),
+                slicer2.graph,
+                html.Br(),
+                slicer2.slider,
+                *slicer2.stores,
+            ]
+        ),
+    ],
+)
+
+
+if __name__ == "__main__":
+    app.run_server(debug=True)

test_deploy/predeploy.py

@@ -0,0 +1,8 @@
+import shutil
+import subprocess
+
+# Install dash-slicer from dev version
+subprocess.run("python -m pip install -e .".split(" "))
+# Use requirements of app
+shutil.copy("test_deploy/requirements.txt", "requirements.txt")
+subprocess.run("python -m pip install -r requirements.txt".split(" "))

test_deploy/requirements.txt

@@ -0,0 +1,7 @@
+pillow
+numpy
+plotly
+dash
+dash_core_components
+imageio
+gunicorn