ipycc 0.1.0

A Python package for creative coding in Jupyter

ipycc

A Python package for creative coding in Jupyter

ipycc is a friendly tool for learning to code, making art, and exploring mathematics within Jupyter notebooks. It runs smoothly in JupyterLite, creating a nice way to start coding in the web browser without installing any software. Try it out at https://code.ipy.cc!

ipycc provides two ways to draw. The first way is called a Sketch, which has commands (methods) for setting colors and drawing shapes such as triangles, circles, and rectangles. Sketch is heavily inspired by p5.js and borrows from its source code and documentation. It also mimics py5 where possible.

The second way to draw is called a Turtle, which includes methods for moving an imaginary turtle and setting its pen color. Turtle is a (mostly) drop-in replacement for Turtle graphics from the Python standard library. It borrows from the standard library's source code and documentation, and bundles the Vec2D class along with a few helper functions.

Under the hood, ipycc draws using the powerful ipycanvas package.

A tour of ipycc

Here are a few quick examples of ipycc in action.

Sketches

A light gray square with a circle in its center. The circle is drawn with a white center and a black edge.

from ipycc.sketch import Sketch

# Create a sketch and show it.
s = Sketch()
s.show()

# Paint the background.
s.background(200)

# Draw a circle.
s.circle(50, 50, 20)

A purple square with a circle in its center. The circle is drawn with a pink center and a thick white edge.

from ipycc.sketch import Sketch

# Create a sketch and show it.
s = Sketch(400, 400)
s.show()

# Paint the background.
s.background("darkorchid")

# Style the circle.
s.stroke_weight(5)
s.stroke("ghostwhite")
s.fill("fuchsia")

# Draw the circle.
s.circle(200, 200, 100)

A purple square with a circle in its center. The circle is drawn with a pink center and a thick white edge. It moves slowly to the right.

from ipycc.sketch import Sketch

# Create a sketch and show it.
s = Sketch(400, 400)
s.show()

# Define a function to draw frames in an animation.
def draw():
    # Paint the background.
    s.background("darkorchid")

    # Calculate the circle's x-coordinate.
    x = s.frame_count * 3

    # Style the circle.
    s.stroke_weight(5)
    s.stroke(248, 248, 255) # ghostwhite in RGB
    s.fill("#FF00FF") # fuchsia in hex

    # Draw the circle.
    s.circle(x, 200, 100)

# Run the animation for 5 seconds.
s.run_sketch(draw, 5)

Turtles

A white square with a short black line extending from the center to the right. A black arrow tip at the end of the line points up.

from ipycc.turtle import Turtle, showscreen

# Show the screen.
showscreen()

# Create a turtle.
t = Turtle()

# Draw a line.
t.forward(50)
# Turn left.
t.left(90)

A white square with the outline of a smaller black square. The smaller square is drawn one side at a time.

from ipycc.turtle import Turtle, showscreen

# Show the screen.
showscreen()

# Create a turtle.
t = Turtle()

# Draw a square.
for i in range(4):
    t.forward(50)
    t.left(90)

A black square with a sprial pattern drawn in green. The spiral is drawn one side at a time.

from ipycc.turtle import Turtle, showscreen, bgcolor

# Show the screen.
showscreen()

# Set the background color.
bgcolor("black")

# Create a turtle.
t = Turtle()

# Style the turtle.
t.color(0, 1, 0) # green in RGB

# Draw a spiral.
for i in range(40):
    length = i * 5
    t.forward(length)
    t.left(90)

Installing ipycc

If you'd like to install ipycc locally on your computer, start by downloading Python. You can then create a virtual environment and install ipycc from your terminal like so:

On Linux/macOS:

mkdir ipycc
cd ipycc
python3 -m venv venv
source venv/bin/activate
pip install jupyterlab ipycc

On Windows:

mkdir ipycc
cd ipycc
py -m venv venv
venv\Scripts\activate
pip install jupyterlab ipycc

The Python Packaging User Guide has additional information to help you get up and running.

Launching JupyterLab

At this point, you're ready to launch JupyterLab by running the jupyter lab command. By default, JupyterLab will only send 1,000 messages (drawing instructions) per second to your web browser. Complex animations require lots of drawing instructions, so you'll probably need to raise this limit. Each time you open your terminal, run the following commands to start coding with ipycc:

On Linux/macOS:

cd ipycc
source venv/bin/activate
jupyter lab --ZMQChannelsWebsocketConnection.iopub_msg_rate_limit=1.0e10

On Windows:

cd ipycc
venv\Scripts\activate
jupyter lab --ZMQChannelsWebsocketConnection.iopub_msg_rate_limit=1.0e10

The command line argument --ZMQChannelsWebsocketConnection.iopub_msg_rate_limit=1.0e10 allows the Python kernel to send drawing instructions fast enough for most animations. Increase the value 1.0e10 if you see the message IOPub message rate exceeded appear in your notebook.

Alternatives

If you're running ipycc locally, you may also be interested in py5 which uses Processing for drawing. py5 has advanced features that you may wish to explore at some point.

The standard library's version of Turtle graphics doesn't run in the web browser, but you can run it locally from Jupyter using the following magic command:

from turtle import Turtle

%gui tk

t = Turtle()
t.forward(50) # opens in a separate window

License

ipycc is licensed under the GNU Lesser General Public License v3.0.

Contributing

Found a bug or typo? Want a new feature? Feel free to open an issue in the project's GitHub repository!