Skip to content

Commit a324b0f

Browse files
gmanchongmanchon
committed
add jupyterlite + github pages boilerplate
1 parent a3a6df9 commit a324b0f

File tree

5 files changed

+216
-0
lines changed

5 files changed

+216
-0
lines changed

‎.github/workflows/deploy.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Build and Deploy
2+
3+
on:
4+
push:
5+
branches:
6+
- jupyterlite
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v4
14+
- name: Setup Python
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version: '3.11'
18+
- name: Install the dependencies
19+
run: |
20+
python -m pip install -r requirements.txt
21+
- name: Build the JupyterLite site
22+
run: |
23+
cp README.md content
24+
jupyter lite build --contents content --output-dir dist
25+
- name: Upload artifact
26+
uses: actions/upload-pages-artifact@v3
27+
with:
28+
path: ./dist
29+
30+
deploy:
31+
needs: build
32+
if: github.ref == 'refs/heads/jupyterlite'
33+
permissions:
34+
pages: write
35+
id-token: write
36+
37+
environment:
38+
name: github-pages
39+
url: ${{ steps.deployment.outputs.page_url }}
40+
41+
runs-on: ubuntu-latest
42+
steps:
43+
- name: Deploy to GitHub Pages
44+
id: deployment
45+
uses: actions/deploy-pages@v4

‎.gitignore

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
*.bundle.*
2+
lib/
3+
node_modules/
4+
.yarn-packages/
5+
*.egg-info/
6+
.ipynb_checkpoints
7+
*.tsbuildinfo
8+
9+
# Created by https://www.gitignore.io/api/python
10+
# Edit at https://www.gitignore.io/?templates=python
11+
12+
### Python ###
13+
# Byte-compiled / optimized / DLL files
14+
__pycache__/
15+
*.py[cod]
16+
*$py.class
17+
18+
# C extensions
19+
*.so
20+
21+
# Distribution / packaging
22+
.Python
23+
build/
24+
develop-eggs/
25+
dist/
26+
downloads/
27+
eggs/
28+
.eggs/
29+
lib/
30+
lib64/
31+
parts/
32+
sdist/
33+
var/
34+
wheels/
35+
pip-wheel-metadata/
36+
share/python-wheels/
37+
.installed.cfg
38+
*.egg
39+
MANIFEST
40+
41+
# PyInstaller
42+
# Usually these files are written by a python script from a template
43+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
44+
*.manifest
45+
*.spec
46+
47+
# Installer logs
48+
pip-log.txt
49+
pip-delete-this-directory.txt
50+
51+
# Unit test / coverage reports
52+
htmlcov/
53+
.tox/
54+
.nox/
55+
.coverage
56+
.coverage.*
57+
.cache
58+
nosetests.xml
59+
coverage.xml
60+
*.cover
61+
.hypothesis/
62+
.pytest_cache/
63+
64+
# Translations
65+
*.mo
66+
*.pot
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# pyenv
78+
.python-version
79+
80+
# celery beat schedule file
81+
celerybeat-schedule
82+
83+
# SageMath parsed files
84+
*.sage.py
85+
86+
# Spyder project settings
87+
.spyderproject
88+
.spyproject
89+
90+
# Rope project settings
91+
.ropeproject
92+
93+
# Mr Developer
94+
.mr.developer.cfg
95+
.project
96+
.pydevproject
97+
98+
# mkdocs documentation
99+
/site
100+
101+
# mypy
102+
.mypy_cache/
103+
.dmypy.json
104+
dmypy.json
105+
106+
# Pyre type checker
107+
.pyre/
108+
109+
# OS X stuff
110+
*.DS_Store
111+
112+
# End of https://www.gitignore.io/api/python
113+
114+
# jupyterlite
115+
*.doit.db
116+
_output

‎.nojekyll

Whitespace-only changes.

‎repl/jupyter-lite.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"jupyter-lite-schema-version": 0,
3+
"jupyter-config-data": {
4+
"disabledExtensions": [
5+
"@jupyterlab/drawio-extension",
6+
"jupyterlab-kernel-spy",
7+
"jupyterlab-tour"
8+
]
9+
}
10+
}

‎requirements.txt

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Core modules (mandatory)
2+
jupyterlite-core==0.5.0
3+
jupyterlab~=4.3.4
4+
notebook~=7.3.2
5+
6+
7+
# Python kernel (optional)
8+
jupyterlite-pyodide-kernel==0.5.0
9+
10+
# JavaScript kernel (optional)
11+
jupyterlite-javascript-kernel==0.3.0
12+
13+
# Language support (optional)
14+
jupyterlab-language-pack-fr-FR
15+
jupyterlab-language-pack-zh-CN
16+
17+
# P5 kernel (optional)
18+
jupyterlite-p5-kernel==0.1.0
19+
20+
# JupyterLab: Fasta file renderer (optional)
21+
jupyterlab-fasta>=3.3.0,<4
22+
# JupyterLab: Geojson file renderer (optional)
23+
jupyterlab-geojson>=3.4.0,<4
24+
# JupyterLab: guided tour (optional)
25+
# TODO: re-enable after https://github.com/jupyterlab-contrib/jupyterlab-tour/issues/82
26+
# jupyterlab-tour
27+
# JupyterLab: dark theme
28+
jupyterlab-night
29+
# JupyterLab: Miami nights theme (optional)
30+
jupyterlab_miami_nights
31+
32+
# Python: ipywidget library for Jupyter notebooks (optional)
33+
ipywidgets>=8.1.3,<9
34+
# Python: ipyevents library for Jupyter notebooks (optional)
35+
ipyevents>=2.0.1
36+
# Python: interative Matplotlib library for Jupyter notebooks (optional)
37+
ipympl>=0.8.2
38+
# Python: ipycanvas library for Jupyter notebooks (optional)
39+
ipycanvas>=0.9.1
40+
# Python: ipyleaflet library for Jupyter notebooks (optional)
41+
ipyleaflet
42+
43+
# Python: plotting libraries (optional)
44+
plotly>=5,<6
45+
bqplot

0 commit comments

Comments
 (0)