https://github.com/coatless-quarto/pyodide

Community developed Quarto extension to enable interactive Python code cells in HTML documents using Pyodide
https://github.com/coatless-quarto/pyodide

interactive-code pyodide python quarto quarto-extension

Last synced: about 15 hours ago
JSON representation

Community developed Quarto extension to enable interactive Python code cells in HTML documents using Pyodide

• Host: GitHub
• URL: https://github.com/coatless-quarto/pyodide
• Owner: coatless-quarto
• Created: 2023-06-01T17:58:47.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-06T22:48:21.000Z (5 months ago)
• Last Synced: 2025-01-16T08:11:38.783Z (8 days ago)
• Topics: interactive-code, pyodide, python, quarto, quarto-extension
• Language: JavaScript
• Homepage: http://quarto.thecoatlessprofessor.com/pyodide/
• Size: 4.42 MB
• Stars: 73
• Watchers: 5
• Forks: 7
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Pyodide Extension for Quarto HTML Documents 

> [!IMPORTANT]

>

> Looking for the official Quarto WebAssembly backend? Check out [`quarto-live`](https://github.com/r-wasm/quarto-live)!

This community developed Quarto extension enables the [Pyodide](https://pyodide.org/en/stable/) code cell within various [Quarto](https://quarto.org/) formats, including [HTML](https://quarto.org/docs/output-formats/html-basics.html), [RevealJS](https://quarto.org/docs/presentations/revealjs/), [Websites](https://quarto.org/docs/websites/), [Blogs](https://quarto.org/docs/websites/website-blog.html), and [Books](https://quarto.org/docs/books). 

![`quarto-pyodide` Filter in Action](https://i.imgur.com/gzAyV8H.gif)

Check out the above example of the extension in action [here](https://quarto.thecoatlessprofessor.com/pyodide/examples/readme)!

Interested in an R version? Take a look at [`quarto-webr`](https://github.com/coatless/quarto-webr)!

> [!NOTE]

> Please note that the `{quarto-pyodide}` Quarto extension is a community-driven initiative and is **not** affiliated with Posit, Quarto, or the main [Pyodide](https://pyodide.org/en/stable/) project. Its evolution and maintenance stem solely from the collective efforts of community members.

## Installation 

To use this extension in a [Quarto project](https://quarto.org/docs/projects/quarto-projects.html), install it from within the project's working directory by typing into **Terminal**:

``` bash

quarto add coatless-quarto/pyodide

```

After the installation process is finished, the extension will be readily available for Quarto documents within the designated working directory. Please note that if you are working on projects located in different directories, you will need to repeat this installation step for each of those directories.

## Usage

For each document, place the `pyodide` filter in the document's header:

```yaml

filters:

  - pyodide

```

Then, place the Python code for `Pyodide` in a code block marked with `{pyodide-python}`

````markdown

---

title: Pyodide in Quarto HTML Documents

format: html

filters:

  - pyodide

---

This is a pyodide-enabled code cell in a Quarto HTML document.

```{pyodide-python}

n = 5

while n > 0:

  print(n)

  n = n - 1

print('Blastoff!')

```

````

The rendered document can be viewed online [here](https://quarto.thecoatlessprofessor.com/pyodide/examples/readme).

For help setting up other use cases, please see our [Templates](https://quarto.thecoatlessprofessor.com/pyodide/qpyodide-deployment-templates.html) collection.

## Help

To report a bug, please [add an issue](https://github.com/coatless-quarto/pyodide/issues/new) to the repository's [bug tracker](https://github.com/coatless-quarto/pyodide/issues).

Want to contribute a feature? Please open an issue ticket to discuss the feature before sending a pull request. 

## Acknowledgements

Please see our [acknowledgements page](https://quarto.thecoatlessprofessor.com/pyodide/qpyodide-acknowledgements.html).