Introduction

simple helper library for common ANSI escape codes

Dependencies

This driver depends on:

Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

Note

This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

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

pip3 install circuitpython-ansi-escape-code

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

sudo pip3 install circuitpython-ansi-escape-code

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-ansi-escape-code

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:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install ansi_escape_code

Or the following command to update an existing version:

circup update

Usage Example

See scripts in the examples directory of this repository.

import ansi_escape_code as terminal
print(
    terminal.ANSIColors.fg.lightblue
    + "Hello "
    + terminal.ANSIColors.fg.green
    + "World "
    + terminal.ANSIColors.fg.orange
    + ":-)"
    + terminal.ANSIColors.reset
)

Contributing

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

to locally check if your changes have a chance to pass the workflows run

pre-commit run --all-files

multiple times. ;-)

Table of Contents

Examples