https://github.com/s-light/circuitpython_ansi_escape_code
simple helper library for common ANSI escape codes
https://github.com/s-light/circuitpython_ansi_escape_code
ansi circuitpython colors cursor escape position python3 sequence terminal
Last synced: 3 months ago
JSON representation
simple helper library for common ANSI escape codes
- Host: GitHub
- URL: https://github.com/s-light/circuitpython_ansi_escape_code
- Owner: s-light
- License: mit
- Created: 2022-01-05T07:08:12.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-26T09:52:53.000Z (5 months ago)
- Last Synced: 2025-06-26T08:16:54.505Z (4 months ago)
- Topics: ansi, circuitpython, colors, cursor, escape, position, python3, sequence, terminal
- Language: Python
- Homepage:
- Size: 115 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-ansi-escape-code/badge/?version=latest
:target: https://circuitpython-ansi-escape-code.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/s-light/CircuitPython_ansi_escape_code/workflows/Build%20CI/badge.svg
:target: https://github.com/s-light/CircuitPython_ansi_escape_code/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
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:
.. code-block:: shell
pip3 install circuitpython-ansi-escape-code
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-ansi-escape-code
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 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:
.. 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 ansi_escape_code
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See scripts in the examples directory of this repository.
.. code-block:: python
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
.. code-block:: shell
pre-commit run --all-files
multiple times. ;-)