• Abstract
• Let's start using py-me
• Calling py-me from a Web App
• Accessing py-me as a Client-Side server
• Py-me defined exceptions
  • Unpermitted Modules Exception
    • Permitted Modules
  • Banned Words Exception
• Code of Conduct
• Issues we are inviting contributors to fix
• Contributors
• Clone this Repository

• Py-me is a Socket.io API used to execute a Python snippet and get back the output for easier software developement.
• Py-me is secure, free and can be accessed from any language that has Socket.io Framework.
• Py-me was built specially for static webpages hosted on free web hosting services like GitHub, Glitch and Heroku where you might have to pay for a Backend services.
• A static website has various limitations which can be overcome using py-me.

Imagine py-me as a function that takes in Python code as argument and returns it's output as a string. Py-me can be accessed in 2 ways:

• Calling from a Web app
• Accessing py-me as a Client-Side server

This is what py-me was built for, running a python script off a website using JavaScript.

Configure your website to run py-me in 2 steps :

• Step 1 : Add this Socket.io link to your HTML page.

<script src="https://py-me.herokuapp.com/socket.io/socket.io.js"></script>

• Step 2 : Initialize the socket in your JS file.

var socket = io("https://py-me.herokuapp.com/");

• To send your python code to the server for execution, use the socket.emit() method. This is similar to a HTTP request. socket.emit() method takes 2 arguements. The 1st arguement shall always be "py-me" and the 2nd one is a JSON object containing your code in a key named "code".

socket.emit("py-me", { code : python_code } );

• To get the output back, use socket.on() method. It takes 2 arguements with the first one being "py-out" and the second one being a JS callback function whose arguement is a JSON Object (data).

The data object consists of code (the python code executed), output (output of the Python code) and exceptions (any exceptions defined by py-me).

  socket.on("py-out", (data) => {
  console.log("Py-me replied");
  console.log("Py-me said "+JSON.stringify(data));
  console.log("\n");
  console.log("code : "+String(data.code));
  console.log("output : "+String(data.output));
  console.log("exceptions : "+String(data.exceptions));
  });

The final JS code file looks something like :

var socket = io("https://py-me.herokuapp.com/");

python_code=`
# Your Python code here :
print("hello world")
`;

socket.emit("py-me", { code : python_code } );

socket.on("py-out", (data) => {
console.log("Py-me replied");
console.log("Py-me said "+JSON.stringify(data));
console.log("\n");
console.log("code : "+String(data.code));
console.log("output : "+String(data.output));
console.log("exceptions : "+String(data.exceptions));
});

Here is an example web python interpreter built using py-me : Web App Based Example

Source Code of the below website

You can access py-me from any programming language as long as the language supports Socket.io Client. Some other languages are :

• Python
• NodeJS
• Java
• C++
• Swift
• Dart

For more info, check this out : Socket.io Docs

This example will explain How to call py-me from a NodeJS server :

• Installation : Install Socket.io-client 2.3.0 from npm.

npm install [email protected]

Other socket.io-client versions might have problems connecting to py-me.

• Initialization : Add the following lines to initialize your socket connection to py-me.

const sio = require("socket.io-client")
const io = sio.connect("https://py-me.herokuapp.com/");

• Emit event : To send your python code to the server for execution, use the io.emit() method. This is similar to a HTTP request. io.emit() method takes 2 arguements. The 1st arguement shall always be "py-me" and the 2nd one is a JSON object containing your python code in a key named "code".

io.emit("py-me", { code : python_code } );

• Receive event : To get the output back, use io.on() method. It takes 2 arguements with the first one being "py-out" and the second one being a JS callback function whose arguement is a JSON Object (data).

The data object consists of code (the python code executed), output (output of the Python code) and exceptions (any exceptions defined by py-me).

  io.on("py-out", (data) => {
  console.log("Py-me replied");
  console.log("Py-me said "+JSON.stringify(data));
  console.log("\n");
  console.log("code : "+String(data.code));
  console.log("output : "+String(data.output));
  console.log("exceptions : "+String(data.exceptions));
  });

• Final code : Run your final code using NodeJS.

// npm install [email protected]
const sio = require("socket.io-client")
const io = sio.connect("https://py-me.herokuapp.com/");

var python_code = 'print("hello world")';

io.emit("py-me", { code : python_code } );

io.on("py-out", (data) => {
console.log("Py-me replied");
console.log("Py-me said "+JSON.stringify(data));
console.log("\n");
console.log("code : "+String(data.code));
console.log("output : "+String(data.output));
console.log("exceptions : "+String(data.exceptions));
});

Py-me allows only certain built-in and external modules to be used as a measure of security. When you use py-me API, the python code is sent from your desktop or website to a cloud server where it is executed. A harmful piece of code that tampers with the existing file structure of the server could shutdown py-me services. Thus here are a list of few Modules that are permitted to use :

Unpermitted Modules Exception arises when you try to use any modules other than the permitted ones.

Note that importing a module as something else will also throw this exception.

The only external module available to use is numpy and scipy.

import random          # This would work just fine
import random as rd    # This would throw an exception since "random as rd" is not in permitted modules list.
import numpy as np     # This would work since "numpy as np" is defined in the permitted list.

Py-me doesn't allow certain words and functions to be used in the code. These words are :

These are either existing file names in the server or commands we don't want you to perform. We would appreciate if you don't use these set of words anywhere in your code.

• Don't create, modify or delete files in py-me.
• Don't use py-me as a data storage server. All files except the program files required for py-me would be deleted every 30 seconds.
• Don't use py-me for programs that consume a lot of time and cpu resources.

• Add synchronous ability to handle multiple requests at once.
• Execute the code in a python virtual environment rather than in the same level as the server.
• Add documentation to access py-me from other languages.

• Clone Glitch Repo
• Clone Github Repo