adafruit-circuitpython-turtle


Nameadafruit-circuitpython-turtle JSON
Version 3.0.2 PyPI version JSON
download
home_pageNone
SummaryTurtle graphics library for CircuitPython and displayio
upload_time2024-10-07 22:35:18
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython turtle graphics turtle
VCS
bugtrack_url
requirements Adafruit-Blinka
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-turtle/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/turtle/en/latest/
    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
    :target: https://adafru.it/discord
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_turtle/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_turtle/actions/
    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

Turtle graphics library for CircuitPython and displayio


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

Installing from PyPI
=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-turtle/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-turtle

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-turtle

To install in a virtual environment in your current project:

.. code-block:: shell

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

Usage Example
=============

.. code-block:: python

    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.pencolor(Color.BLUE)

    turtle.penup()
    turtle.goto(-starsize/2, 0)
    turtle.pendown()

    start = turtle.pos()
    while True:
        turtle.forward(starsize)
        turtle.left(170)
        if abs(turtle.pos() - start) < 1:
            break

    while True:
        pass

Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/turtle/en/latest/>`_.

For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_turtle/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-turtle",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, turtle, graphics, turtle",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/50/95/28cbf22ae2cb4ab23768da3ce5c824b2d98564247748e5037fe4f8658520/adafruit_circuitpython_turtle-3.0.2.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-turtle/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/turtle/en/latest/\n    :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_turtle/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_turtle/actions/\n    :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\n\nTurtle graphics library for CircuitPython and displayio\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-turtle/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-turtle\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-turtle\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n    mkdir project-name && cd project-name\n    python3 -m venv .venv\n    source .venv/bin/activate\n    pip3 install adafruit-circuitpython-turtle\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    import board\n    from adafruit_turtle import Color, turtle\n\n    turtle = turtle(board.DISPLAY)\n    starsize = min(board.DISPLAY.width, board.DISPLAY.height) * 0.9  # 90% of screensize\n\n    print(\"Turtle time! Lets draw a star\")\n\n    turtle.pencolor(Color.BLUE)\n\n    turtle.penup()\n    turtle.goto(-starsize/2, 0)\n    turtle.pendown()\n\n    start = turtle.pos()\n    while True:\n        turtle.forward(starsize)\n        turtle.left(170)\n        if abs(turtle.pos() - start) < 1:\n            break\n\n    while True:\n        pass\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/turtle/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_turtle/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Turtle graphics library for CircuitPython and displayio",
    "version": "3.0.2",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_turtle"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " turtle",
        " graphics",
        " turtle"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d748e0ef45f8a8fb77bf0a58a009a249cce7bf87583dd0798aca2fa991446acb",
                "md5": "313df00536bdec2df9f8df05f31b131c",
                "sha256": "c72299210dc9278052739260f415762b25df93909b08009076c35f4cba1150eb"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_turtle-3.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "313df00536bdec2df9f8df05f31b131c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 12761,
            "upload_time": "2024-10-07T22:35:16",
            "upload_time_iso_8601": "2024-10-07T22:35:16.652314Z",
            "url": "https://files.pythonhosted.org/packages/d7/48/e0ef45f8a8fb77bf0a58a009a249cce7bf87583dd0798aca2fa991446acb/adafruit_circuitpython_turtle-3.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "509528cbf22ae2cb4ab23768da3ce5c824b2d98564247748e5037fe4f8658520",
                "md5": "ccceebf5924836cb996c64938e0e1894",
                "sha256": "dcefcc0b9ace830376fa1aa0fe4717b4c199f53a9c28c1990a66461faa501364"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_turtle-3.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "ccceebf5924836cb996c64938e0e1894",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 36135,
            "upload_time": "2024-10-07T22:35:18",
            "upload_time_iso_8601": "2024-10-07T22:35:18.558260Z",
            "url": "https://files.pythonhosted.org/packages/50/95/28cbf22ae2cb4ab23768da3ce5c824b2d98564247748e5037fe4f8658520/adafruit_circuitpython_turtle-3.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 22:35:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_turtle",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-turtle"
}
        
Elapsed time: 0.72049s