Merge pull request #234 from maxfordham/update-testing-workflow

- update env files (dev and docs) to get package dependencies from `pyproject.toml` file - update binder button to launch with Voila - fix docs deploy (hopefully)
maxfordham · Dec 8, 2023 · 621fbb7 · 621fbb7
2 parents 5ff7555 + 38b6666
commit 621fbb7
Show file tree

Hide file tree

Showing 10 changed files with 52 additions and 77 deletions.
diff --git a/.github/workflows/test-python-package.yml b/.github/workflows/test-python-package.yml
@@ -9,7 +9,7 @@ on:
     - cron: '0 0 * * *'
 
 env:
-  CACHE_NUMBER: 0  # increase to reset cache manually
+  CACHE_NUMBER: 1  # increase to reset cache manually
 
 jobs:
   build:
@@ -58,20 +58,21 @@ jobs:
 
       - name: Install flake8
         run: |
-          conda install -n my-env flake8
-
-      - name: Lint with flake8
-        shell: bash -l {0}
-        run: |
-          # stop the build if there are Python syntax errors or undefined names
-          # Ignore scripts folder as mainly archived scripts
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-
-      - name: Install pytest
-        run: |
-          conda install -n my-env pytest
+          mamba install -n my-env flake8
+
+      # - name: Lint with flake8
+      #   shell: bash -l {0}
+      #   run: |
+      #     # stop the build if there are Python syntax errors or undefined names
+      #     # Ignore scripts folder as mainly archived scripts
+      #     flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+      #     # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+      #     flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+      # - name: Install pytest
+      #   run: |
+      #     mamba install -n my-env pytest
+      # ^ REMOVED AS `pytest` IN `environment.yml`
 
       - name: Run tests
         shell: bash -l {0}

diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
 # ipyautoui
 
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/maxfordham/ipyautoui/HEAD) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![PyPI version](https://badge.fury.io/py/ipyautoui.svg)](https://badge.fury.io/py/ipyautoui) [![Test Python Package](https://github.com/maxfordham/ipyautoui/actions/workflows/test-python-package.yml/badge.svg)](https://github.com/maxfordham/ipyautoui/actions/workflows/test-python-package.yml)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/maxfordham/ipyautoui/HEAD?urlpath=voila%2Frender%2Fdocs%2Fdemo.ipynb) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![PyPI version](https://badge.fury.io/py/ipyautoui.svg)](https://badge.fury.io/py/ipyautoui) [![Test Python Package](https://github.com/maxfordham/ipyautoui/actions/workflows/test-python-package.yml/badge.svg)](https://github.com/maxfordham/ipyautoui/actions/workflows/test-python-package.yml)
 
 ![](images/logo.png)
 
 ## Try it online!
 
-launch [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/maxfordham/ipyautoui/HEAD).
+launch [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/maxfordham/ipyautoui/HEAD?urlpath=voila%2Frender%2Fdocs%2Fdemo.ipynb).
 
 ## Installation
 

diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/autodisplay.ipynb b/docs/autodisplay.ipynb
@@ -52,7 +52,7 @@
     "tags": []
    },
    "source": [
-    "```{warning} the demo requires a python kernel to run. Try on Binder [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/maxfordham/ipyautoui/HEAD)\n",
+    "```{warning} the demo requires a python kernel to run. Try on Binder [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/maxfordham/ipyautoui/HEAD?urlpath=voila%2Frender%2Fdocs%2Fdemo.ipynb)\n",
     "```"
    ]
   },

diff --git a/docs/conf.py b/docs/conf.py
@@ -7,7 +7,7 @@
 comments_config = {'hypothesis': False, 'utterances': False}
 copyright = '2022'
 exclude_patterns = ['**.ipynb_checkpoints', '.DS_Store', 'Thumbs.db', '_build']
-extensions = ['sphinx_togglebutton', 'sphinx_copybutton', 'myst_nb', 'jupyter_book', 'sphinx_thebe', 'sphinx_comments', 'sphinx_external_toc', 'sphinx.ext.intersphinx', 'sphinx_design', 'sphinx_book_theme', 'sphinx.ext.todo', 'sphinx.ext.autosummary', 'sphinxcontrib.mermaid', 'sphinx_jupyterbook_latex']
+extensions = ['sphinx_togglebutton', 'sphinx_copybutton', 'myst_nb', 'jupyter_book', 'sphinx_thebe', 'sphinx_comments', 'sphinx_external_toc', 'sphinx.ext.intersphinx', 'sphinx_design', 'sphinx_book_theme', 'sphinx.ext.todo', 'sphinxcontrib.mermaid', 'sphinx_jupyterbook_latex']
 external_toc_exclude_missing = False
 external_toc_path = '_toc.yml'
 html_baseurl = ''

diff --git a/docs/demo.ipynb b/docs/demo.ipynb
@@ -44,7 +44,7 @@
     "tags": []
    },
    "source": [
-    "```{warning} the demo requires a python kernel to run. Try on Binder [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/maxfordham/ipyautoui/HEAD)\n",
+    "```{warning} the demo requires a python kernel to run. Try on Binder [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/maxfordham/ipyautoui/HEAD?urlpath=voila%2Frender%2Fdocs%2Fdemo.ipynb)\n",
     "```"
    ]
   },

diff --git a/docs/environment.yml b/docs/environment.yml
@@ -2,39 +2,25 @@ name: ipyautoui-docs
 # channels priority
 # see https://bioconda.github.io/
 # conda-forge has highest prioriy
-# -
-# jg notes
-# -
-# - needs everything that ipyautoui needs + everything for docs
-# - in future when packaged could make ipyautoui a dependency
-#   - in CI just make sure packaging happens first
 channels:
+  - defaults
   - conda-forge
 dependencies:
-  - python>=3.7
-  - pandas
-  - jupyterlab>4
-  - ipywidgets
-  - ipyfilechooser
-  - ipydatagrid
-  - ipyvuetify
+  - python
+  - jupyterlab>=4.0.0,<5.0.0a0
+  - jupyterlab-unfold
+  - jupyterlab-lsp
+  - jupyterlab-myst
+  - python-lsp-server
   - voila
-  - plotly
-  - halo
+  - voici
   - jupytext
-  - markdown
-  - nodejs
-  - altair
-  - pydantic>2
-  - pydantic-settings
-  - stringcase
-  - pyyaml
-  - pillow
-  - openpyxl
   - black
   - nb_black
-  - immutables
-  - wcmatch
+  - pytest
+  - altair # optional
+  - halo # optional
+  - plotly # optional
   - jupyter-book # for docs
   - sphinx # for docs
   - sphinx-book-theme # for docs
@@ -43,10 +29,9 @@ dependencies:
   - nbsphinx-link
   - sphinxcontrib-mermaid
   - sphinx-panels
-  - pytest
   - pip
   - pip:
-    - maplocal==0.1.1
-    - pytest-sphinx
-    - jsonref
+    - maplocal==0.2.1
     - pydantic-extra-types
+    - pytest-examples
+    - -e ..
diff --git a/environment.yml b/environment.yml
@@ -7,38 +7,22 @@ channels:
   - conda-forge
 dependencies:
   - python
-  - numpy
-  - pandas
   - jupyterlab>=4.0.0,<5.0.0a0
   - jupyterlab-unfold
   - jupyterlab-lsp
+  - jupyterlab-myst
   - python-lsp-server
-  - ipywidgets>8
-  - ipyfilechooser
-  - ipydatagrid
-  - ipyvuetify
   - voila
-  - plotly
-  - halo
   - jupytext
-  - markdown
-  - nodejs
-  - altair
-  - pydantic>2
-  - pydantic-settings
-  - python-dotenv
-  - pyyaml
-  - openpyxl
   - black
   - nb_black
-  - immutables
-  - wcmatch
   - pytest
-  - stringcase
+  - altair # optional
+  - halo # optional
+  - plotly # optional
   - pip
   - pip:
     - maplocal==0.2.1
     - pydantic-extra-types
     - pytest-examples
-    - jsonref
     - -e .
diff --git a/pyproject.toml b/pyproject.toml
@@ -22,6 +22,7 @@ dependencies = [
     "ipydatagrid>=1.1.14",
     "ipyfilechooser",       # make optional
     "ipyvuetify",           # make optional
+    "markdown",
     "Markdown",
     "jsonref",
     "numpy",

diff --git a/tests/testdata/test.aui.json b/tests/testdata/test.aui.json
@@ -29,5 +29,15 @@
     "dropdown_simple": "asd",
     "text": "adsf",
     "text_short": "short text",
-    "textarea": "long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text "
+    "textarea": "long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text long text ",
+    "select_multiple": [
+        "apple"
+    ],
+    "select_multiple_nullable": null,
+    "tags_input": [
+        "a"
+    ],
+    "tags_input_nullable": [
+        "a"
+    ]
 }