README.md

Effortlessly run Python code in your React apps.

---

Try it out

You can try out react-py in the playground.

Quickstart

Install react-py with:

npm install react-py

Then, wrap your app in a PythonProvider component.

import { PythonProvider } from 'react-py'

function App() {
  return (
    // Add the provider to your app
    <PythonProvider>
      <Codeblock />
    </PythonProvider>
  )
}

render(<App />, document.getElementById('root'))

Using the usePython hook, you can run code and access both stdout and stderr. For full usage instructions and framework specific guides, see the usage docs.

Documentation

For full documentation, visit elilambnz.github.io/react-py.

Examples

Basic Example

REPL

Interrupting Execution

Using Packages

File System

Custom Modules

Making API Calls

User Input

Data Visualisation

Limitations

Most of the Python standard library is functional, except from some modules. The following modules can be imported, but are not functional due to the limitations of the WebAssembly VM:

• multiprocessing
• threading
• sockets

Learn more about the limitations here.

License

react-py is available under the MIT License.

Maintainers

Eli Lamb - elilambnz
James Ansley - James-Ansley

Acknowledgments

This project uses Pyodide, a Python distribution for the browser and Node.js based on WebAssembly.

Contributing

If you're interested in contributing, please read our contributing docs before submitting a pull request.