Add tailwind styles to Girder 5

.circleci/config.yml

@@ -10,15 +10,59 @@ executors:
       - image: rabbitmq
     resource_class: large
 commands:
+  use_nvm:
+      description: "Use nvm"
+      parameters:
+        node:
+          type: string
+          default: v20
+      steps:
+        - run:
+            name: Use nvm
+            # see https://discuss.circleci.com/t/nvm-does-not-change-node-version-on-machine/28973/14
+            command: |
+              echo 'export NVM_DIR="/root/.nvm"' >> $BASH_ENV
+              echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"' >> $BASH_ENV
+        - restore_cache:
+            name: Restore nvm cache
+            key: v1-nvm-cache-<< parameters.node >>
+        - run:
+            name: Switch node versions
+            command: |
+              nvm install << parameters.node >>
+              nvm alias default << parameters.node >>
+              NODE_DIR=$(dirname $(which node))
+              echo "export PATH=$NODE_DIR:\$PATH" >> $BASH_ENV
+        - run:
+            name: Check node versions
+            command: |
+              node --version
+              npm --version
+  build_client:
+    description: "Build HistomicsUI client"
+    steps:
+      - run:
+          name: Build client
+          command: |
+            pushd histomicsui/web_client
+            npm ci
+            npm run build
+            popd
+  install_playwright:
+    description: "Install playwright"
+    steps:
+      - run:
+          name: Install playwright with dependencies
+          command: |
+            pushd histomicsui/web_client
+            npx playwright install --with-deps
+            popd
   tox:
     description: "Run tox"
     parameters:
       env:
         type: string
     steps:
-      - run:
-          name: Preinstall phantomjs to work around an npm permission issue
-          command: npm install -g phantomjs-prebuilt --unsafe-perm
       - run:
           name: Run tests via tox
           # Piping through cat does less buffering of the output but can
@@ -42,34 +86,57 @@ jobs:
     executor: toxandnode
     steps:
       - checkout
+      - use_nvm
+      - build_client
       - tox:
           env: py310
       - coverage
   py311:
     executor: toxandnode
     steps:
       - checkout
+      - use_nvm
+      - build_client
       - tox:
           env: py311
       - coverage
   py312:
     executor: toxandnode
     steps:
       - checkout
+      - use_nvm
+      - build_client
       - tox:
           env: py312
       - coverage
   py313:
     executor: toxandnode
     steps:
       - checkout
+      - use_nvm
+      - build_client
       - tox:
           env: py313
       - coverage
+  web_client:
+    executor: toxandnode
+    environment:
+      CI: "true"
+      HEADLESS: "true"
+      GIRDER_CLIENT_TESTING_MONGO_URI: mongodb://localhost:27017
+    steps:
+      - checkout
+      - use_nvm
+      - build_client
+      - install_playwright
+      - tox:
+          env: webtest
   noanalysis:
     executor: toxandnode
     steps:
       - checkout
+      - use_nvm
+      - build_client
       - tox:
           env: noanalysis
       - coverage
@@ -84,6 +151,8 @@ jobs:
       - image: girder/tox-and-node
     steps:
       - checkout
+      - use_nvm
+      - build_client
       - deploy:
           name: Run tests via tox
           # Piping through cat does less buffering of the output but can
@@ -136,6 +205,13 @@ workflows:
             branches:
               ignore:
                 - gh-pages
+      - web_client:
+          filters:
+            tags:
+              only: /^v.*/
+            branches:
+              ignore:
+                - gh-pages
       - release:
           requires:
             - py310
@@ -147,4 +223,6 @@ workflows:
             tags:
               only: /^v.*/
             branches:
-              only: master
+              only:
+                - master
+                - girder-5

.circleci/get_version.py

@@ -0,0 +1,19 @@
+import re
+
+import setuptools_scm
+
+
+def main():
+    version = setuptools_scm.get_version()
+    expected_version_regex = r'(\d+\.\d+\.\d+)a(\d+).+$'
+    match = re.match(expected_version_regex, version)
+    if not match:
+        error_message = f'Version {version} does not match the expected format'
+        raise ValueError(error_message)
+    base_version = match.group(1)
+    alpha_version = match.group(2)
+    print(f'{base_version}a{alpha_version}')
+
+
+if __name__ == '__main__':
+    main()

.circleci/publish_pypi.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -e
+
+export SETUPTOOLS_SCM_PRETEND_VERSION=`python -m setuptools_scm | sed "s/.* //"`
+if [ "${CIRCLE_BRANCH-:}" = "master" ]; then
+    export SETUPTOOLS_SCM_PRETEND_VERSION=`echo $SETUPTOOLS_SCM_PRETEND_VERSION | sed "s/\+.*$//"`
+elif [ "${CIRCLE_BRANCH-:}" = "girder-5" ]; then
+    SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+    pip install setuptools-scm
+    export SETUPTOOLS_SCM_PRETEND_VERSION=$(python "$SCRIPT_DIR/get_version.py")
+fi
+
+python -m build
+twine check dist/*
+twine upload --skip-existing dist/*

.git-blame-ignore-revs

@@ -13,3 +13,7 @@ f1c2190ab04ab867c655b4217f807e9f567772c8
 9475b89640a6de84788b79ba68d5ed9aeb1a9ff4
 # PR 359: Apply ruff formatting and linting
 97b21f031e4769043b2c3a464ea4cf8e9a60c219
+# PR 443: Format Girder 5
+d184bf1c2d5c12e643f8e5536c7707744c72e7ba
+0e0e6009391bcbf9bde7be6ebbb121cf84ae1f32
+cbc3c3952acef976b7b0be732e9ebb7686e98c8e

.gitignore

@@ -12,6 +12,7 @@ env/
 build/
 develop-eggs/
 dist/
+dist-app/
 downloads/
 eggs/
 .eggs/

.pre-commit-config.yaml

@@ -48,7 +48,8 @@ repos:
   - id: codespell
     args:
       - --ignore-words-list
-      - "hist,indext,pixelx,thex,subtile"
+      - "hist,indext,pixelx,thex,subtile,afterAll"
+      - --exclude-file=histomicsui/web_client/package-lock.json
 - repo: https://github.com/syntaqx/git-hooks
   rev: v0.0.18
   hooks:

MANIFEST.in

@@ -6,3 +6,6 @@ graft histomicsui
 graft docs
 prune test
 global-exclude *.py[co] *.cmake __pycache__ node_modules
+
+prune histomicsui/web_client
+recursive-include histomicsui/web_client/dist/*

README.rst

@@ -68,6 +68,12 @@ Now install the histomicsui package, have Girder build its UI, and start the Gir
   girder build
   girder serve
 
+Note that ``girder serve`` should only be used in development. In production, use a WSGI server such as gunicorn, e.g.::
+
+.. code-block:: bash
+
+  gunicorn girder.wsgi:app --bind=localhost:8080 --workers=4 --preload
+
 To use Girder Worker:
 
 .. code-block:: bash