build: refactor build strategy

.github/workflows/test.yml

@@ -6,101 +6,77 @@ on:
   - workflow_dispatch
 
 jobs:
-  build:
+  lint:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Install node
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
-          node-version: "14.x"
-          registry-url: "https://registry.npmjs.org"
+          python-version: "3.10"
+      - uses: pre-commit/[email protected]
 
-      - name: Install Python
-        uses: actions/setup-python@v2
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
-          python-version: "3.x"
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install twine wheel jupyter-packaging jupyterlab
-
-      - name: Build
-        run: |
-          python setup.py generate_source
-          python setup.py sdist bdist_wheel
-
-      - name: Build
-        run: |
-          cd js
-          npm pack
-
-      - name: Upload builds
-        uses: actions/upload-artifact@v3
+          python-version: "3.10"
+      # https://github.com/webpack/webpack/issues/14532
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - name: install build
+        run: python -m pip install build
+      - name: build wheel
+        run: python -m build
+      - uses: actions/upload-artifact@v3
         with:
           name: ipyvuetify-dist-${{ github.run_number }}
           path: |
             ./dist
             ./js/*.tgz
 
   test:
-    needs: [build]
+    needs: [lint, build]
     runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9, "3.10", "3.11"]
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11"]
     steps:
-      - uses: actions/checkout@v2
-
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
       - uses: actions/download-artifact@v3
         with:
           name: ipyvuetify-dist-${{ github.run_number }}
-
-      - name: Install Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install
-        run: pip install dist/*.whl
-
-      - name: Import
-        # do the import in a subdirectory, as after installation, files in de current directory are also imported
-        run: |
-          (mkdir test-install; cd test-install; python -c "from ipyvuetify import Btn")
+      - name: Install ipyvuetify
+        run: python -m pip install "$(find dist -name *.whl)"
+      - name: test import
+        run: (mkdir test-install; cd test-install; python -c "from ipyvuetify import Btn")
 
   ui-test:
-    needs: [build]
+    needs: [lint, build]
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
-
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
       - uses: actions/download-artifact@v3
         with:
           name: ipyvuetify-dist-${{ github.run_number }}
-
-      - name: Install Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.8
-
-      - name: Install vuetify and test deps
-        run: |
-          wheel=(dist/*.whl)
-          pip install ${wheel}[test] "jupyter_server<2"
-
-      - name: Install playwright browsers
+      - name: Install ipyvuetify
+        run: python -m pip install "$(find dist -name *.whl)[test]"
+      - name: Install chromium
         run: playwright install chromium
-
       - name: Run ui-tests
         run: pytest tests/ui/ --video=retain-on-failure --solara-update-snapshots-ci -s
-
       - name: Upload Test artifacts
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: ipyvuetify-test-results
           path: test-results

.gitignore

@@ -1,10 +1,13 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
 *.egg-info/
 .eggs/
-.ipynb_checkpoints/
 dist/
 build/
-*.py[cod]
-**/node_modules/
 
 # generated code
 generate_source/build
@@ -16,6 +19,14 @@ ipyvuetify/labextension/
 ipyvuetify/nbextension/
 js/lib
 
-# readthedocs
-_build/
+# Sphinx documentation
+docs/_build/
 
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Unit test / coverage reports
+.ruff_cache
+
+# node installed dependencies
+**/node_modules/

MANIFEST.in

@@ -4,3 +4,4 @@ recursive-include ipyvuetify/labextension *.*
 include jupyter-vuetify.json
 recursive-include ipyvuetify/extra *.vue
 recursive-include generate_source/ *.*
+recursive-include js/ *.*

docs/requirements.txt

@@ -1,4 +1,4 @@
 ipyvuetify>=1.2.2<2
 jupyter-sphinx==0.2.4a1
 sphinx_rtd_theme
-
+ipykernel

generate_source/generate_schema.py

@@ -1,6 +1,7 @@
 import json
 import re
 from itertools import chain
+from pathlib import Path
 
 sizes = ["xs", "sm", "md", "lg", "xl"]
 
@@ -92,8 +93,8 @@ def make_type(api_type):
             "oneOf": list(filter(identity, map(make_type, api_type))),
         }
 
+    # Not supported
     if api_type == "function":
-        # Not supported
         return None
 
     print(f"Unknown type: {api_type}")
@@ -150,8 +151,8 @@ def make_widget(data):
     name, attributes = data
     widget_name = kebab_to_camel(name)
 
+    # Widgets without props are directives, internationalization or $vuetify
     if "props" not in attributes.keys():
-        # Widgets without props are directives, internationalization or $vuetify
         return None
 
     properties = chain(*filter(identity, map(make_properties, attributes["props"])))
@@ -166,14 +167,16 @@ def make_widget(data):
 
 
 def generate_schema(
-    vuetify_api_file_name, base_schema_file_name, schema_output_file_name
+    vuetify_api_file_name: Path,
+    base_schema_file_name: Path,
+    schema_output_file_name: Path,
 ):
-    api_data = json.loads(open(vuetify_api_file_name).read())
-    base_schema = json.loads(open(base_schema_file_name).read())
+    api_data = json.loads(vuetify_api_file_name.read_text())
+    base_schema = json.loads(base_schema_file_name.read_text())
 
     widgets = filter(identity, map(make_widget, api_data.items()))
 
     schema = {"widgets": {**base_schema["widgets"], **dict(widgets)}}
 
-    with open(schema_output_file_name, "w") as outfile:
+    with schema_output_file_name.open("w") as outfile:
         json.dump(schema, outfile)

generate_source/generate_source.py

@@ -1,53 +1,48 @@
-import os
-import platform
 import shutil
 import subprocess
+from pathlib import Path
 
-from .generate_schema import generate_schema
-
-here = os.path.dirname(os.path.abspath(__file__))
-
-vuetify_api = f"{here}/vuetify_api.json"
-base_schema = f"{here}/base.json"
-build_dir = f"{here}/build"
-widget_gen_schema = f"{build_dir}/widget_gen_schema.json"
+from pynpm import NPMPackage
 
-widgetgen = f"{here}/node_modules/.bin/widgetgen"
+from .generate_schema import generate_schema
 
-es6_template = f"{here}/es6-template.njk"
-python_template = f"{here}/python.njk"
+here = Path(__file__).parent
 
-project_dir = f"{here}/.."
-destination_js = f"{project_dir}/js/src/generated"
-destination_python = f"{project_dir}/ipyvuetify/generated"
+vuetify_api = here / "vuetify_api.json"
+base_schema = here / "base.json"
+build_dir = here / "build"
+widget_gen_schema = build_dir / "widget_gen_schema.json"
 
+widgetgen = here / "node_modules" / ".bin" / "widgetgen"
 
-def reset_dir(name):
-    if os.path.isdir(name):
-        shutil.rmtree(name)
+es6_template = here / "es6-template.njk"
+python_template = here / "python.njk"
 
-    os.mkdir(name)
+project_dir = here.parent
+destination_js = project_dir / "js" / "src" / "generated"
+destination_python = project_dir / "ipyvuetify" / "generated"
 
 
-npm = "npm"
-if platform.system() == "Windows":
-    npm = "npm.cmd"
+def reset_dir(name: Path):
+    shutil.rmtree(name, ignore_errors=True)
+    name.mkdir(exist_ok=True)
 
 
 def generate():
-    if not os.path.isdir(build_dir):
-        os.mkdir(build_dir)
+
+    build_dir.mkdir(exist_ok=True)
 
     generate_schema(vuetify_api, base_schema, widget_gen_schema)
 
-    subprocess.check_call(f"{npm} install", cwd=here, shell=True)
+    NPMPackage(here / "package.json").install()
 
     reset_dir(destination_js)
+
     subprocess.check_call(
         f"{widgetgen} -p json -o {destination_js} -t {es6_template} {widget_gen_schema} es6",
         shell=True,
     )
-    with open(f"{destination_js}/.eslintrc.js", "w") as f:
+    with open(destination_js / ".eslintrc.js", "w") as f:
         f.write(
             """
             module.exports = {