Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bugzpodder committed Nov 20, 2023
1 parent 05e8151 commit 1f20b60
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/docs/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
16 changes: 16 additions & 0 deletions packages/pysandbox/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 1f20b60

Please sign in to comment.