https://github.com/kermanx/slidev-addon-python-runner
A Slidev addon for running Python code in your slides.
https://github.com/kermanx/slidev-addon-python-runner
pyodide python slidev slidev-addon
Last synced: 9 months ago
JSON representation
A Slidev addon for running Python code in your slides.
- Host: GitHub
- URL: https://github.com/kermanx/slidev-addon-python-runner
- Owner: kermanx
- License: mit
- Created: 2024-11-29T16:30:03.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-02T04:06:46.000Z (about 1 year ago)
- Last Synced: 2025-03-25T07:41:28.273Z (9 months ago)
- Topics: pyodide, python, slidev, slidev-addon
- Language: TypeScript
- Homepage:
- Size: 263 KB
- Stars: 18
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# slidev-addon-python-runner
Python runner for the [Monaco Runner feature](https://sli.dev/features/monaco-run) in [Slidev](https://sli.dev/). Code executed in browser using [Pyodide](https://pyodide.org/).
## Usage
Firstly, install the package:
```bash
npm install slidev-addon-python-runner
```
Then, add it as an addon in your headmatter in `slides.md`:
```md
---
addons:
- slidev-addon-python-runner
# Optional configuration for this runner
python:
# Install packages from PyPI. Default: []
installs: ["cowsay"]
# Code executed to set up the environment. Default: ""
prelude: |
GREETING_FROM_PRELUDE = "Hello, Slidev!"
# Automatically load the imported builtin packages. Default: true
loadPackagesFromImports: true
# Disable annoying warning from `pandas`. Default: true
suppressDeprecationWarnings: true
# Always reload the Python environment when the code changes. Default: false
alwaysReload: false
# Options passed to `loadPyodide`. Default: {}
loadPyodideOptions: {}
---
```
To add an interactive Python code runner, use the `monaco-run` directive:
````md
```py {monaco-run}
from termcolor import colored
print(colored("Hello, Slidev!", "blue"))
```
````
## Bundle `pyodide`
By default, when building slides (i.e. `slidev build`), the `pyodide` package will be replaced with the CDN version. This is because of https://github.com/pyodide/pyodide/issues/1949, which causes the imported python packages to be lost when using the bundled version.
To bundle the local version of `pyodide`, set the `PYODIDE_BUNDLE` environment variable to `true`. Note that in this way you can't import python packages in the static build.