Example jupyterlab extension using myst.

This is an almost complete rewrite of pypyri-lab for JupyterLab 4 using
Myst for rendering

.flake8

@@ -3,7 +3,7 @@
 # https://flake8.readthedocs.io/en/latest/user/configuration.html
 # https://flake8.readthedocs.io/en/latest/user/error-codes.html
 # https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes
-exclude = __init__.py,versioneer.py
+exclude = node_modules,jupyter_server_test_config.py
 ignore =
     # bug bear assert False
     B011,
@@ -30,5 +30,6 @@ ignore =
     # redefinition of unused 'loop' from line 10
     F811,
 max-line-length = 120
+max-complexity = 50
 
 

.github/workflows/papyri-lab-build.yml

@@ -0,0 +1,187 @@
+name: Papyri-lab Build
+
+on:
+  push:
+    branches: main
+  pull_request:
+    branches: '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        submodules: true
+
+    - name: Base Setup
+      uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+    - name: Install dependencies
+      run: python -m pip install -U "jupyterlab>=4.0.0,<5"
+
+    - name: Lint the extension
+      run: |
+        set -eux
+        cd papyri-lab
+        jlpm
+        jlpm run lint:check
+
+    - name: Test the extension
+      run: |
+        set -eux
+        cd papyri-lab
+        jlpm run test
+
+    - name: Build the extension
+      run: |
+        set -eux
+        # install papyri first, then do the extension
+        pip install -e .
+        pip install scipy
+        papyri build-parser
+        papyri gen examples/papyri.toml
+        papyri ingest ~/.papyri/data/*
+        echo 'CD to extension'
+        cd papyri-lab
+        python -m pip install .[test]
+
+        pytest -vv -r ap --cov papyri_lab
+        jupyter server extension list
+        jupyter server extension list 2>&1 | grep -ie "papyri_lab.*OK"
+
+        jupyter labextension list
+        jupyter labextension list 2>&1 | grep -ie "papyri-lab.*OK"
+        python -m jupyterlab.browser_check
+
+    - name: Package the extension
+      run: |
+        set -eux
+        cd papyri-lab
+
+        pip install build
+        python -m build
+        pip uninstall -y "papyri_lab" jupyterlab
+
+    - name: Upload extension packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: extension-artifacts
+        path: papyri-lab/dist/papyri_lab*
+        if-no-files-found: error
+
+  test_isolated:
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Install Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+        architecture: 'x64'
+
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        submodules: true
+
+    - name: Install papyri
+      run: |
+        set -eux
+        # install papyri first, then do the extension
+        pip install -e .
+        pip install scipy
+        papyri build-parser
+
+    - uses: actions/download-artifact@v3
+      with:
+        name: extension-artifacts
+
+    - name: Install and Test
+      run: |
+        set -eux
+        # Remove NodeJS, twice to take care of system and locally installed node versions.
+        sudo rm -rf $(which node)
+        sudo rm -rf $(which node)
+
+        pip install "jupyterlab>=4.0.0,<5" papyri_lab*.whl
+
+
+        jupyter server extension list
+        jupyter server extension list 2>&1 | grep -ie "papyri_lab.*OK"
+
+        jupyter labextension list
+        jupyter labextension list 2>&1 | grep -ie "papyri-lab.*OK"
+        python -m jupyterlab.browser_check --no-browser-test
+
+  integration-tests:
+    name: Integration tests
+    needs: build
+    runs-on: ubuntu-latest
+
+    env:
+      PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/pw-browsers
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        submodules: true
+
+    - name: Base Setup
+      uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+    - name: Install papyri
+      run: |
+        set -eux
+        # install papyri first, then do the extension
+        pip install -e .
+        pip install scipy
+        papyri build-parser
+
+    - name: Download extension package
+      uses: actions/download-artifact@v3
+      with:
+        name: extension-artifacts
+
+    - name: Install the extension
+      run: |
+        set -eux
+        python -m pip install "jupyterlab>=4.0.0,<5" papyri_lab*.whl
+
+    - name: Install dependencies
+      working-directory: papyri-lab/ui-tests
+      env:
+        YARN_ENABLE_IMMUTABLE_INSTALLS: 0
+        PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+      run:
+        jlpm install
+
+    - name: Set up browser cache
+      uses: actions/cache@v3
+      with:
+        path: |
+          ${{ github.workspace }}/pw-browsers
+        key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }}
+
+    - name: Install browser
+      run: |
+        jlpm playwright install chromium
+      working-directory: papyri-lab/ui-tests
+
+    - name: Execute integration tests
+      working-directory: papyri-lab/ui-tests
+      run: |
+        jlpm playwright test
+
+    - name: Upload Playwright Test report
+      if: always()
+      uses: actions/upload-artifact@v3
+      with:
+        name: papyri_lab-playwright-tests
+        path: |
+          papyri-lab/ui-tests/test-results
+          papyri-lab/ui-tests/playwright-report

papyri-lab/.copier-answers.yml

@@ -0,0 +1,19 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.2.4
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: [email protected]
+author_name: Matthias Bussonnier
+data_format: string
+file_extension: ''
+has_binder: false
+has_settings: true
+kind: frontend
+labextension_name: papyri-lab
+mimetype: ''
+mimetype_name: ''
+project_short_description: A JupyterLab extension for papyri
+python_name: papyri_lab
+repository: https://github.com/jupyter/papyri
+test: true
+viewer_name: ''
+

papyri-lab/.github/workflows/check-release.yml

@@ -0,0 +1,26 @@
+name: Check Release
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["*"]
+
+jobs:
+  check_release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Base Setup
+        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - name: Check Release
+        uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2
+        with:
+
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload Distributions
+        uses: actions/upload-artifact@v3
+        with:
+          name: papyri_lab-releaser-dist-${{ github.run_number }}
+          path: .jupyter_releaser_checkout/dist

papyri-lab/.github/workflows/prep-release.yml

@@ -0,0 +1,41 @@
+name: "Step 1: Prep Release"
+on:
+  workflow_dispatch:
+    inputs:
+      version_spec:
+        description: "New Version Specifier"
+        default: "next"
+        required: false
+      branch:
+        description: "The branch to target"
+        required: false
+      post_version_spec:
+        description: "Post Version Specifier"
+        required: false
+      since:
+        description: "Use PRs with activity since this date or git reference"
+        required: false
+      since_last_stable:
+        description: "Use PRs with activity since the last stable git tag"
+        required: false
+        type: boolean
+jobs:
+  prep_release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+      - name: Prep Release
+        id: prep-release
+        uses: jupyter-server/jupyter_releaser/.github/actions/prep-release@v2
+        with:
+          token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
+          version_spec: ${{ github.event.inputs.version_spec }}
+          post_version_spec: ${{ github.event.inputs.post_version_spec }}
+          branch: ${{ github.event.inputs.branch }}
+          since: ${{ github.event.inputs.since }}
+          since_last_stable: ${{ github.event.inputs.since_last_stable }}
+
+      - name: "** Next Step **"
+        run: |
+          echo "Optional): Review Draft Release: ${{ steps.prep-release.outputs.release_url }}"

papyri-lab/.github/workflows/publish-release.yml

@@ -0,0 +1,57 @@
+name: "Step 2: Publish Release"
+on:
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: "The target branch"
+        required: false
+      release_url:
+        description: "The URL of the draft GitHub release"
+        required: false
+      steps_to_skip:
+        description: "Comma separated list of steps to skip"
+        required: false
+
+jobs:
+  publish_release:
+    runs-on: ubuntu-latest
+    permissions:
+      # This is useful if you want to use PyPI trusted publisher
+      # and NPM provenance
+      id-token: write
+    steps:
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+      - name: Populate Release
+        id: populate-release
+        uses: jupyter-server/jupyter_releaser/.github/actions/populate-release@v2
+        with:
+          token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
+          branch: ${{ github.event.inputs.branch }}
+          release_url: ${{ github.event.inputs.release_url }}
+          steps_to_skip: ${{ github.event.inputs.steps_to_skip }}
+
+      - name: Finalize Release
+        id: finalize-release
+        env:
+          # The following are needed if you use legacy PyPI set up
+          # PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+          # PYPI_TOKEN_MAP: ${{ secrets.PYPI_TOKEN_MAP }}
+          # TWINE_USERNAME: __token__
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        uses: jupyter-server/jupyter_releaser/.github/actions/finalize-release@v2
+        with:
+          token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
+          release_url: ${{ steps.populate-release.outputs.release_url }}
+
+      - name: "** Next Step **"
+        if: ${{ success() }}
+        run: |
+          echo "Verify the final release"
+          echo ${{ steps.finalize-release.outputs.release_url }}
+
+      - name: "** Failure Message **"
+        if: ${{ failure() }}
+        run: |
+          echo "Failed to Publish the Draft Release Url:"
+          echo ${{ steps.populate-release.outputs.release_url }}