Skip to content

Meta-programming project that creates the py5 library code.

License

Notifications You must be signed in to change notification settings

tabreturn/py5generator

 
 

Repository files navigation

py5 logo

py5

py5 PyPI Downloads

py5 is a new version of Processing for Python 3.8+. It makes the Java Processing jars available to the CPython interpreter using JPype. It can do just about everything Processing can do, except with Python instead of Java code.

The goal of py5 is to create a new version of Processing that is integrated into the Python ecosystem. Built into the library are thoughtful choices about how to best get py5 to work with other popular Python libraries such as numpy or Pillow.

Here is a simple example of a working py5 Sketch, written in module mode:

import py5


def setup():
    py5.size(200, 200)
    py5.rect_mode(py5.CENTER)


def draw():
    py5.square(py5.mouse_x, py5.mouse_y, 10)


py5.run_sketch()

If you have Java 17 installed on your computer, you can install py5 using pip:

pip install py5

Detailed installation instructions are available on the documentation website. There are some Special Notes for Mac Users that you should read if you use OSX.

There are currently four basic ways to use py5. They are:

  • module mode, as shown above
  • class mode: create a Python class inherited from py5.Sketch. This mode supports multiple Sketches running at the same time.
  • imported mode: simplified code that omits the py5. prefix. This mode is supported by the py5 Jupyter notebook kernel and the run_sketch command line utility.
  • static mode: functionless code to create static images. This mode is supported by the py5bot Jupyter notebook kernel, the %%py5bot IPython magic, and the run_sketch command line utility.

py5generator is a meta-programming project that creates the py5 library. To view the actual installed py5 library code, look at the py5 repository. All py5 library development is done through py5generator.

The documentation website, https://py5.ixora.io/, is very much a work in progress. The reference documentation is solid but the how-to's and tutorials need a lot of work.

About

Meta-programming project that creates the py5 library code.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 76.1%
  • Java 22.8%
  • Other 1.1%