Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bugzpodder committed Sep 21, 2023
1 parent f67649e commit f549c68
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export default defineConfig({
title: "PySandbox Docs",
social: {
github: "https://github.com/bugzpodder/pysandbox",
discord: "https://discord.gg/BYB2kvyFwm",
},
sidebar: [
{
Expand Down
6 changes: 3 additions & 3 deletions docs/src/content/docs/guides/comparison.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ description: A comparison of PySandbox and other libraries.

## Pyodide

PySandbox uses [Pyodide](https://github.com/pyodide/pyodide) under the hood. If you are running python code on the main thread, you may enjoy the flexibility of loading Pyodide directly. On the other hand, PySandbox provides a handy `display` utility for showing pyplots and managing other iPython _repr_\*\*\*\* outputs.
PySandbox uses [Pyodide](https://github.com/pyodide/pyodide) under the hood. If you are running python code on the main thread, it's fairly simple to bootstrap Pyodide directly in your code. On the other hand, PySandbox will provide additional utilities like `display` for showing pyplots and managing other [IPython](https://ipython.readthedocs.io/en/stable/config/integrating.html) outputs.

Pyodide also doesn't provide web worker support out of the box. If you site is [crossOriginIsolated](https://web.dev/coop-coep/), PySandbox would be able to run the python code in a web worker out of the box.
Pyodide does not setup web workers out of the box. If you site is [crossOriginIsolated](https://web.dev/coop-coep/), PySandbox can be easily configured to execute python code in a web worker.

## PyScript

[PyScript](https://pyscript.net/) is great for quickly configuring a single html page to run python code. However if you are using a JS web-framework (such as React) to build your web application, PySandbox will be able to provide finer grained control via its Javascript based API.
[PyScript](https://pyscript.net/) is great for configuring a single html page to run python code. However if you are using a JS web-framework (e.g. a React-based framework) to build your web application, PySandbox can provide finer-grained control from its API.

0 comments on commit f549c68

Please sign in to comment.