Skip to content
left! right! forward! turtle power!
Branch: master
Clone or download
ladyada Merge pull request #9 from dastels/master
Example additions and edits
Latest commit bae9464 Jun 29, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Pylint cleanup Jun 29, 2019
.travis.yml Add cookiecutter output Jun 24, 2019 Add cookiecutter output Jun 24, 2019
LICENSE Add cookiecutter output Jun 24, 2019
README.rst Clean up todos Jun 25, 2019 Change logging level to INFO Jun 29, 2019
requirements.txt Add cookiecutter output Jun 24, 2019



Documentation Status Discord Build Status

Turtle graphics library for CircuitPython and displayio


This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-turtle

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-turtle

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-turtle

Usage Example

import board
from adafruit_turtle import Color, turtle

turtle = turtle(board.DISPLAY)
starsize = min(board.DISPLAY.width, board.DISPLAY.height) * 0.9  # 90% of screensize

print("Turtle time! Lets draw a star")


turtle.goto(-starsize/2, 0)

start = turtle.pos()
while True:
    if abs(turtle.pos() - start) < 1:

while True:


Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-turtle --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.