Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-color-terminal/badge/?version=latest
:target: https://docs.circuitpython.org/projects/color_terminal/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_Color_Terminal/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Color_Terminal/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
Extension of supports ANSI color escapes for subsets of text
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
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-color-terminal/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-color-terminal
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-color-terminal
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-color-terminal
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_color_terminal
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import supervisor
from displayio import Group
from terminalio import FONT
from adafruit_color_terminal import ColorTerminal
main_group = Group()
display = supervisor.runtime.display
font_bb = FONT.get_bounding_box()
screen_size = (display.width // font_bb[0], display.height // font_bb[1])
terminal = ColorTerminal(FONT, screen_size[0], screen_size[1])
main_group.append(terminal.tilegrid)
black = chr(27) + "[30m"
red = chr(27) + "[31m"
green = chr(27) + "[32m"
yellow = chr(27) + "[33m"
blue = chr(27) + "[34m"
magenta = chr(27) + "[35m"
cyan = chr(27) + "[36m"
white = chr(27) + "[37m"
reset = chr(27) + "[0m"
message = f"Hello {green}World{reset} {yellow}ANSI\n"
terminal.write(message)
print(message, end="")
message = f"{magenta}Terminal {red}Colors{reset}"
terminal.write(message)
print(message)
display.root_group = main_group
print(terminal.cursor_x, terminal.cursor_y)
move_cursor = chr(27) + "[10;10H"
terminal.write(f" Something {move_cursor}{cyan} Else{reset}")
print(f" Something {move_cursor}{cyan} Else{reset}")
while True:
pass
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/color_terminal/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_Color_Terminal/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-color-terminal",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, color_terminal, ANSI, Colors, Color, Terminal, EscapeCode, EscapeCodes, Console",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/4d/28/dab2622039415ba3e231f912960826c5c51dde679d56a8f759f2a94e144a/adafruit_circuitpython_color_terminal-0.2.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-color-terminal/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/color_terminal/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Color_Terminal/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Color_Terminal/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nExtension of supports ANSI color escapes for subsets of text\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\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-color-terminal/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-color-terminal\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-color-terminal\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 .env/bin/activate\n pip3 install adafruit-circuitpython-color-terminal\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_color_terminal\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import supervisor\n from displayio import Group\n from terminalio import FONT\n\n from adafruit_color_terminal import ColorTerminal\n\n main_group = Group()\n display = supervisor.runtime.display\n font_bb = FONT.get_bounding_box()\n screen_size = (display.width // font_bb[0], display.height // font_bb[1])\n\n terminal = ColorTerminal(FONT, screen_size[0], screen_size[1])\n main_group.append(terminal.tilegrid)\n\n black = chr(27) + \"[30m\"\n red = chr(27) + \"[31m\"\n green = chr(27) + \"[32m\"\n yellow = chr(27) + \"[33m\"\n blue = chr(27) + \"[34m\"\n magenta = chr(27) + \"[35m\"\n cyan = chr(27) + \"[36m\"\n white = chr(27) + \"[37m\"\n reset = chr(27) + \"[0m\"\n\n\n message = f\"Hello {green}World{reset} {yellow}ANSI\\n\"\n terminal.write(message)\n print(message, end=\"\")\n\n message = f\"{magenta}Terminal {red}Colors{reset}\"\n terminal.write(message)\n print(message)\n\n display.root_group = main_group\n\n print(terminal.cursor_x, terminal.cursor_y)\n\n move_cursor = chr(27) + \"[10;10H\"\n terminal.write(f\" Something {move_cursor}{cyan} Else{reset}\")\n print(f\" Something {move_cursor}{cyan} Else{reset}\")\n\n while True:\n pass\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/color_terminal/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_Color_Terminal/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Extension of terminalio.Terminal that supports ANSI color escapes for subsets of the text",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Color_Terminal"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" color_terminal",
" ansi",
" colors",
" color",
" terminal",
" escapecode",
" escapecodes",
" console"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8963e760fc81942ba0cf9c999b99bd50ee3c05de6c35bf60022e25a3d33a1cbf",
"md5": "ce60ee0e775ebd469e8454533326653c",
"sha256": "ab91ffb0c04e02c8e3984ef0303491dcb021d6a504890fe28f870bdee7bc55ad"
},
"downloads": -1,
"filename": "adafruit_circuitpython_color_terminal-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ce60ee0e775ebd469e8454533326653c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6914,
"upload_time": "2025-10-20T21:50:17",
"upload_time_iso_8601": "2025-10-20T21:50:17.271209Z",
"url": "https://files.pythonhosted.org/packages/89/63/e760fc81942ba0cf9c999b99bd50ee3c05de6c35bf60022e25a3d33a1cbf/adafruit_circuitpython_color_terminal-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4d28dab2622039415ba3e231f912960826c5c51dde679d56a8f759f2a94e144a",
"md5": "9a09943fdeb7d451c7be46f2bfea4627",
"sha256": "fa9f5b217b96ca25e5fec10e02a7fac02f831230f3e15a2d939f73b293325cb5"
},
"downloads": -1,
"filename": "adafruit_circuitpython_color_terminal-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "9a09943fdeb7d451c7be46f2bfea4627",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33756,
"upload_time": "2025-10-20T21:50:18",
"upload_time_iso_8601": "2025-10-20T21:50:18.347355Z",
"url": "https://files.pythonhosted.org/packages/4d/28/dab2622039415ba3e231f912960826c5c51dde679d56a8f759f2a94e144a/adafruit_circuitpython_color_terminal-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-20 21:50:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Color_Terminal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "adafruit-circuitpython-color-terminal"
}
JSON
