rchiodo / vscode-python-web-wasm

An extension allows to run Python code in a Web browser using WebAssembly technology

Project

This project provides a VS Code extension to run Python code in the Web (e.g. vscode.dev) using WebAssembly as an execution engine.

Index

Limitations
Pre-requisites
Python Environments
Versioning
Contributing
Trademarks

Limitations

The extension's intension is to serve as an experimentation environment to help the VS Code team to gain experiences about running Python code in the Web using WebAssembly technologies. It should not be used to do productive Python development since there are limitation in WebAssembly Python interpreted as well as limitations in VS Code itself.

Python interpreter limitations

• no pip support.
• no socket support.
• no support for native Python modules.
• no thread support. As a consequence there is no async support either.

Pre-requisites

The extension depends on the Github Repositories extensions. It also requires you to authenticate with GitHub.

Python Environments

The extension uses a pre-configured Python environment based on the CPython WebAssembly builds. The used build is Python-3.11.0rc1-wasm32-wasi-16.zip

You can setup your own Python environment, included source wheel Python packages, following these steps:

• create a new GitHub repository.
• download a wasm-wasi-16 build from https://github.com/tiran/cpython-wasm-test/releases and expand it into the root of the repository
• to add source wheel packages do the following:
  • create a site-packages folder in the root
  • install the package using the following command pip install my_package --target ./site-packages. Note that you need to have a Python installation in your OS including pip.
• commit the changes
• change the python.wasm.runtime setting to point to your GitHub repository. For example:

{
    "python.wasm.runtime": "https://github.com/dbaeumer/python-3.11.0rc"
}

History

• 0.7.0: added basic debugging support
• 0.5.0: initial version

Versioning

Odd major, minor or patch version numbers indicate an insider or pre-release. So 1.0.0 is a pre-release, 0.1.0 will be a pre-release as well. 2.0.2 will be a regular release.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.