A Python package for creative coding on the web.
Project description
proceso
A Python package for creative coding on the web
proceso is a Python package for creative coding on the web, with a focus on making coding accessible and inclusive for artists, designers, educators, beginners, and anyone else! The package provides a Pythonic interface to the p5.js library and is heavily inspired by py5. proceso is designed for Pyodide-based environments with a focus on PyScript.
Here is an example of how to create a proceso sketch with PyScript using Python, HTML, and CSS:
sketch.py
from proceso import Sketch
p5 = Sketch()
p5.describe("A screen reader accessible description for the canvas.")
index.html
<!DOCTYPE html>
<html lang="en-us">
<head>
<title>My Sketch</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="https://pyscript.net/releases/2023.03.1/pyscript.css" />
<script defer src="https://pyscript.net/releases/2023.03.1/pyscript.js"></script>
<link rel="stylesheet" href="style.css" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/1.6.0/p5.min.js"></script>
<py-config>
packages = ["numpy", "proceso"]
</py-config>
</head>
<body>
<main></main>
<py-script src="sketch.py"></py-script>
</body>
</html>
style.css
html,
body {
margin: 0;
padding: 0;
}
canvas {
display: block;
}
Static Sketches
Similar to Processing, proceso enables beginners to start programming with "static sketches" before introducing animation and interaction. The following example draws a few shapes and a flower on the screen.
from proceso import Sketch
p5 = Sketch()
p5.describe("A rectangle, circle, triangle, and flower drawn in pink on a gray background.")
# Create the canvas
p5.create_canvas(720, 400)
p5.background(200)
# Set colors
p5.fill(204, 101, 192, 127)
p5.stroke(127, 63, 120)
# A rectangle
p5.rect(40, 120, 120, 40)
# A circle
p5.circle(240, 240, 80)
# A triangle
p5.triangle(300, 100, 320, 100, 310, 80)
# A design for a simple flower
p5.translate(580, 200)
p5.no_stroke()
for _ in range(10):
p5.ellipse(0, 30, 20, 80)
p5.rotate(p5.PI / 5)
Active Sketches
proceso's "active sketches" provide the run_sketch() method to handle initialization, looping, and events. The sketch below simulates the synchronization behavior observed in some species of fireflies.
from proceso import Sketch
p5 = Sketch()
p5.describe("Ten white circles moving like fireflies on a dark blue background.")
bugs = []
num_bugs = 10
coupling: object
def setup():
p5.create_canvas(720, 400)
global coupling
coupling = p5.create_slider(0, 10, 5)
for _ in range(num_bugs):
bug = Bug()
bugs.append(bug)
def draw():
p5.background("midnightblue")
for bug in bugs:
bug.sync()
for bug in bugs:
bug.update()
bug.check_edges()
bug.draw()
class Bug:
def __init__(self):
self.x = p5.width * 0.5
self.y = p5.height * 0.5
self.r = 5
self.angle = p5.random(p5.TWO_PI)
self.da_dt = 1
self.dt = 0.01
self.freq = p5.random(5, 10)
def draw(self):
a = p5.remap(self.angle % p5.TWO_PI, 0, p5.TWO_PI, 0, 255)
p5.fill(255, a)
p5.stroke(255, a)
p5.circle(self.x, self.y, 2 * self.r)
def update(self):
self.x += p5.cos(self.angle)
self.y += p5.sin(self.angle)
self.angle += self.da_dt * self.dt
self.da_dt = 0
def check_edges(self):
if self.x > p5.width + self.r:
self.x = -self.r
if self.x < -self.r:
self.x = p5.width + self.r
if self.y > p5.height + self.r:
self.y = -self.r
if self.y < -self.r:
self.y = p5.height + self.r
def sync(self):
K_N = coupling.value() / num_bugs
self.da_dt = self.freq
for bug in bugs:
self.da_dt += K_N * p5.sin(bug.angle - self.angle)
p5.run_sketch(setup=setup, draw=draw)
Getting Started
Cloud: PyScript (account required)
PyScript is a great way to run proceso sketches with PyScript. Here is a project template.
Local: Anaconda + VS Code
Here is one possible setup for running sketches on your local machine:
- Install the Anaconda Distribution of Python.
- Install Visual Studio Code.
- Get started with Anaconda Navigator and create a new Python environment with Python 3.10.
- Use the Navigator to open a terminal with your new Python environment and
pip install proceso. - Open VS Code and install the Microsoft Python extension to enable helpful features such as documentation, autocompletion, and so on.
- Select the interpreter created by your new Python environment.
- Add your HTML, CSS, and Python files and start coding.
- Open the terminal in VS Code and run
python -m http.serverto view your sketch in the browser.
Roadmap
- Improve documentation
- Finish IO API
- Translate p5.js test suite?
- Add CLI with hot reload
- Add bindings for p5.js addon libraries
Acknowledgements
- proceso is, first and foremost, an interface to the p5.js library. Nearly all of the package's documentation and examples are adapted from their p5.js counterparts. Portions of the source code are also adapted from the original JavaScript implementation.
- The
Vectorclass is lovingly borrowed from py5 as are most of py5's naming conventions. - Basthon, Py5.js, and pyp5js all pointed the way.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file proceso-0.0.10.tar.gz.
File metadata
- Download URL: proceso-0.0.10.tar.gz
- Upload date:
- Size: 61.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cd5502d5b81a7bc318054b50e65da1c7a60221ff33e7db98b199ae82b08161b6 |
|
| MD5 | 727d97dd00036208bf864afcaf97f4de |
|
| BLAKE2b-256 | da498f9d0dd17a7dddfb23cce017064e21020490cc35d1e2c22d217d5e3e4563 |
File details
Details for the file proceso-0.0.10-py3-none-any.whl.
File metadata
- Download URL: proceso-0.0.10-py3-none-any.whl
- Upload date:
- Size: 66.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a561b91d5811737402c82d727b9f0deea20197128abcbc78e38c77faac43b5c3 |
|
| MD5 | acc87a360f8f78c322f4aff190646a70 |
|
| BLAKE2b-256 | 44877f581749983a5ef8707933d52077d7d256988e2d73c2eff7202b3ffa4296 |
