Merge pull request #292 from XpressAI/fahreza/binder-preview

✨ Demo Xircuits in Binder

Author: MFA-X-AI

.github/workflows/binder-badge.yaml

@@ -0,0 +1,27 @@
+name: Binder Badge
+on:
+  pull_request_target:
+    types: [opened]
+
+jobs:
+  binder:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+    - name: comment on PR with Binder link
+      uses: actions/github-script@v6
+      with:
+        github-token: ${{secrets.GITHUB_TOKEN}}
+        script: |
+          var PR_HEAD_USERREPO = process.env.PR_HEAD_USERREPO;
+          var PR_HEAD_REF = process.env.PR_HEAD_REF;
+          github.rest.issues.createComment({
+            issue_number: context.issue.number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: `[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/${PR_HEAD_USERREPO}/${PR_HEAD_REF}) :point_left: Launch a binder notebook on branch _${PR_HEAD_USERREPO}/${PR_HEAD_REF}_`
+          })
+      env:
+        PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
+        PR_HEAD_USERREPO: ${{ github.event.pull_request.head.repo.full_name }}

README.md

@@ -23,6 +23,9 @@
     <a href="https://github.com/XpressAI/xircuits/releases">
         <img alt="GitHub release" src="https://img.shields.io/github/release/XpressAI/xircuits.svg?color=yellow">
     </a>
+    <a href="https://mybinder.org/v2/gh/XpressAi/xircuits/main?urlpath=lab">
+        <img alt="Binder" src="https://mybinder.org/badge_logo.svg">
+    </a>
     <a href="https://xircuits.io">
         <img alt="Documentation" src="https://img.shields.io/website/http/xircuits.io.svg?color=orange">
     </a>

binder/environment.yml

@@ -0,0 +1,20 @@
+name: xircuits-demo
+
+channels:
+  - conda-forge
+
+dependencies:
+  # Runtime dependencies installed through conda
+  - python >=3.8,<3.11
+  - pip
+  - nodejs >=18,<19
+
+  - pip:
+    - jupyterlab>=4.0.0,<4.1
+    - jupyter_server>=2.0.1,<3
+    - requests
+    - gitpython
+    - pygithub
+    - tqdm
+    - toml
+    - xircuits

binder/postBuild

@@ -0,0 +1,5 @@
+python -m pip install -U pip
+pip install -e .
+jupyter labextension develop . --overwrite
+jupyter server extension enable xircuits
+xircuits