zmilan / batavia Goto Github PK

Batavia

Batavia is an early alpha project. If it breaks, you get to keep all the shiny pieces.

Batavia is an implementation of the Python virtual machine, written in JavaScript. With Batavia, you can run Python bytecode in your browser.

It honors Python 3.4.4+ syntax and conventions, and allows you to reference objects and classes defined natively in JavaScript.

Quick Start

Prerequisites

Batavia requires a Python 3.4 or Python 3.5 installation, and a virtualenv to run it all in. Python 3.6 is not yet supported.

You also need to have a recent install of Node.js (from the “stable” 6.X series), and a current version of npm. If your version of npm is outdated, you can update it using the command:

$ npm install npm@latest -g

Check the Setting up your environment for configuration help.

Downloading and Installing

1. Clone the code repositories

$ mkdir pybee
$ cd pybee
$ git clone https://github.com/pybee/batavia

2. Setup a virtualenv:

(for other environments, see Getting Started).

Linux/Unix/Mac

Check your python3 version first. If it's pointing to version 3.6, replace $(which python3) in the virtualenv command below with the path to your Python 3.4 or 3.5 installation.

$ python3 --version
$ virtualenv --python=$(which python3) venv
$ . venv/bin/activate
$ cd batavia
$ pip install -e .

Windows

Type in the following commands in your terminal

> virtualenv venv
> venv\Scripts\activate
> cd batavia
> pip install -e .

3. Install Node.js.

You must have a recent version of Node; we do our testing using v6.9.1. Once you've installed Node, you can use it to install the JavaScript dependencies and compile the Batavia library:

$ npm install

4. Compile the Batavia library and bundle it’s dependencies

Run the follwing command in the terminal

$ npm run build

For more detailed setup instructions, see the Getting Started tutorial

Running Batavia in the browser

After you have setup the local installation of Batavia, you can now run Python in the browser:

$ cd testserver
$ pip install -r requirements.txt
$ ./manage.py runserver

then open a web browser at http://localhost:8000

For more detailed instructions, see the Python In The Browser guide.

Documentation

Documentation for Batavia can be found on on Read The Docs, including:

• Project Internals
• Getting Started
• So, why is it called "Batavia"?
• More Frequently Asked Questions

Contributing

If you'd like to contribute to Batavia development, our guide for first time contributors will help you get started.

If you experience problems with Batavia, log them on GitHub.

Community

Batavia is part of the BeeWare suite. You can talk to the community through:

• @pybeeware on Twitter
• The pybee/general channel on Gitter.

We foster a welcoming and respectful community as described in our BeeWare Community Code of Conduct.