Skip to content

Commit

Permalink
updated docs and comments, with instructions that work fora local bui…
Browse files Browse the repository at this point in the history
…ld workflow for me
  • Loading branch information
paddymul committed Oct 22, 2024
1 parent e40e745 commit 4cc5c29
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
xeus-python + JupyterLite deployed as a static site to GitHub Pages, for demo purposes.

## ✨ Try it in your browser ✨

[https://paddymul.github.io/jupyterlite-xeus](https://paddymul.github.io/jupyterlite-xeus)
https://jupyterlite.github.io/xeus-python-demo/notebooks/?path=demo.ipynb

## ≠ How does it compare to the Pyodide kernel?
Expand Down Expand Up @@ -53,3 +53,24 @@ Only ``no-arch`` packages from ``conda-forge`` and packages from ``emscripten-fo
- **How do I know if a package is ``no-arch`` on ``conda-forge``?** ``no-arch`` means that the package is OS-independent, usually pure-python packages are ``no-arch``. To check if your package is ``no-arch`` on ``conda-forge``, check if the "Platform" entry is "no-arch" in the https://beta.mamba.pm/channels/conda-forge?tab=packages page. If your package is not ``no-arch`` but is a pure Python package, then you should probably update the feedstock to turn your package into a ``no-arch`` one.
![](noarch.png)
- **How do I know if my package is on ``emscripten-forge``?** You can see the list of packages pubished on ``emscripten-forge`` [here](https://beta.mamba.pm/channels/emscripten-forge?tab=packages). In case your package is missing, or it's not up-to-date, feel free to open an issue or a PR on https://github.com/emscripten-forge/recipes.
## create a local env for buidling
```sh
conda env create -f build-environment.yml -n jupyterlite-target
conda activate jupyterlite-build
```

## local build

```sh
jupyter lite build --contents content
cd _output
python -m http.server

```

As a one-liner
```sh
#my jupyterlite checkout lives in ~/code/jupyterlite-xeus
cd ~/code/jupyterlite-xeus/ ; rm -rf _output ; time jupyter lite build --contents content && cd _output && python -m http.server
```
7 changes: 6 additions & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,9 @@ channels:
dependencies:
- python=3.11
- xeus-python
- ipycanvas
- pandas
- ipywidgets
- pip
- pip:
- requests
- ../../buckaroo/dist/buckaroo-0.7.8-py3-none-any.whl #relative path to a locally built wheel

0 comments on commit 4cc5c29

Please sign in to comment.