From 1f20b604f35b902132ddc4d27722016208963081 Mon Sep 17 00:00:00 2001 From: Jack Zhao Date: Mon, 20 Nov 2023 02:30:22 +0000 Subject: [PATCH] update readme --- packages/docs/README.md | 4 ++-- packages/pysandbox/README.md | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 packages/pysandbox/README.md diff --git a/packages/docs/README.md b/packages/docs/README.md index d2ddc16..262e8b2 100644 --- a/packages/docs/README.md +++ b/packages/docs/README.md @@ -1,7 +1,7 @@ # PySandbox Docs -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/bugzpodder/pysandbox/tree/main/docs) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/docs) +[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/bugzpodder/pysandbox/tree/main/packages/docs) +[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/bugzpodder/pysandbox/tree/main/packages/docs) ## 🚀 Project Structure diff --git a/packages/pysandbox/README.md b/packages/pysandbox/README.md new file mode 100644 index 0000000..1cca865 --- /dev/null +++ b/packages/pysandbox/README.md @@ -0,0 +1,16 @@ +# PySandbox: Run Python in your Web Application + +For installation and usage instructions see [user docs](https://bugzpodder.github.io/pysandbox) + +## Introduction + +PySandbox is a library that helps developers create client-side Python-powered web applications. It is inspired by [PyScript](https://github.com/pyscript/pyscript) and built on top of [Pyodide](https://github.com/pyodide/pyodide) and [Polyscript](https://github.com/pyscript/polyscript). + +The main features of PySandbox are: + +- Exports simple JS classes that can be used in any JS framework or html page. +- Web Worker ready. If your site is cross origin isolated, Web Workers can be used to execute python code. +- Restricted mode. Enabling this mode will disallow python scripts access to js.document. +- Custom modules support. You can define your own modules that are accessible in the codeblock. +- Input/Output support. You can easily pass data in and out of the python code blocks and display images and/or adding 3rd party JS integration. +- Helper methods for formatting code, find imports and installing modules in Pyodide.