The project’s main goal was to use Tanner’s approach combined with decorator and global variables control to enable P5.js API from being called “directly” from the Python code as clean as possible.
pyp5js covers all the methods, variables and event handlers listed in the p5.js API documentation. Here’s an example of a valid Python code using p5.js API:
from pyp5js import * def setup(): createCanvas(200, 200) background(160) def draw(): fill("blue") background(200) radius = sin(frameCount / 60) * 50 + 50 ellipse(100, 100, radius, radius)
Click here to see a list of
examples generated with
This project requires Python 3 and is now on PyPI, so you can install it with
pip3, depending on your environment:
$ pip install pyp5js
(You might have to install
setuptools first, if it’s not already installed)
Since you’ll be writting Python code and then generating the correspondent P5.js code from it, pyp5js provides a web application interface to help you to generate the files.
So, to start a the application, you’ll have to run:
$ pyp5js serve
Then point your browser to http://localhost:5000/ and create a new sketch via the browser by filling the form with the name of your sketch. This command will compile the sketches on the fly, so after changing/saving the sketch file you just need to reload the page on your browser. It’ll also guide you on which file you have to edit the Python code and how to see it running after you save it.
pyp5js will create a new directory in your home called
If you don’t want to save your sketch in this default directory, you can set
the environment variable
SKETCHBOOK_DIR to point to the directory you want
to use. Or you can also run the
serve command as:
$ SKETCHBOOK_DIR='~/my-custom-sketchbook' pyp5js serve
Now, have fun =]
The web application is an interface to reduce barriers on playing around with
pyp5js to newcomers and people who don’t feel confortable with the terminal
interface. But if you want to use the terminal,
pyp5js also exposes a CLI.
So, to start a new sketch, you’ll have to run:
$ pyp5js new my_sketch
This command will create a directory with the following code structure using p5.js 1.0.0:
~ my_sketch/ ~ static / - p5.js - index.html - my_sketch.py
index.html is prepared to display your sketch, so you’ll have to keep it
open in your browser (I really advise you to use
Firefox) to see results from the
code you’ll add to
To see your app on your browser you’ll need to run a Web server (opening the “index.html” file directly won’t work since it is disabled by default) - we packaged it already for you, just run:
$ pyp5js serve
If you just want to compile your code (without running the Web server) there’s
$ pyp5js transcrypt my_sketch
If you’re lazy as me, you can use the
monitor command instead of the previous
one. The command will monitor your sketch directory and keep track of any
changes on any
.py files. When it notices a new change, it automatically runs
the transcrypt process for you:
$ pyp5js monitor my_sketch
You can also use the
monitor command within the
new by running:
$ pyp5js new my_sketch --monitor
All of the command-line interface methods have a few optional arguments, such as specifying the sketch directory. You can check them by running:
$ pyp5js --help
Remember to use P5.js method names & conventions for most things.
There are no Py.Processing
with context facilities for
There are no
PVector objects, with their nice syntatic operator overloaded sugar - use
createVector() and P5.js conventions … for now…
mouseWheel() event funtion, use
def mouseWheel() with NO parameters, then, inside the function, the magic
event.delta will have a value equivalent to the one returned by Java&Python Mode’s
At this point, it is a known limitation that you have to “declare” global variables before
draw(), maybe using
name = None, as they can’t be created inside methods.
Not all Python libs are available when using Transcrypt because they required a JS-version to be enabled. In this link you can take a look in all modules Transcrypt enables.
Since pyp5js have a lot of moving parts, it would be great to have the p5.js API fully covered and tested. So, use your imagination, code your sketches and, if pyp5js breaks or starts to annoy you with something, you’re very welcome to open an issue documenting your thoughts. Test it and let me know how can I improve it.
If you fell confortable with that, I’d be happy to add some of your pyp5js sketches to our examples list! To do so, you’ll have to fork this repository and add your new sketch example in the
docs/examples directory. Once you’ve your sketch ready, you can open a pull request and I’ll take a look at it.
Okay, if you want to contribute with pyp5js’s code, let’s go! I really advise you to use virtualenv with virtualenvwrapper or pyenv to isolate your pyp5js fork from the rest of your system. Once you have everything ready, you can run:
$ git clone email@example.com:YOUR_GITHUB_PROFILE/pyp5js.git $ mkvirtualenv pyp5js -p /usr/bin/python3 # python3 path can change depending on your system $ cd pyp5js $ pip install -r dev-requirements.txt $ python setup.py develop $ make test
After that, you should have the
pyp5js command enabled and it will respect all the changes you introduce to the code. Now, a brief explanation about the code under
cli.py: the entrypoint for
pyp5jscommands such as
commands.py: just functions responsible for the real implementations for
compiler.py: where all the magic happens!
fs.py: classes to abstract the files and directories manipulations from the commands
exception.py: custom exceptions used by
monitor.py: module with the objects used by the
pyp5js.py: module which is imported by the sketches and integrates with P5.js API
template_renderers.py: simple module with the renderization logic for the code templates like
http/web_app.py: Flask application for the web interface.
Now go fetch yourself an issue and happy hacking!