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/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
simple helper library for common ANSI escape codes
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/circuitpython-ansi-escape-code/>`_.
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 .env
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
pipx 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
<https://github.com/s-light/CircuitPython_ansi_escape_code/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Documentation
=============
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>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/s-light/CircuitPython_ansi_escape_code.git",
"name": "circuitpython-ansi-escape-code",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit blinka circuitpython micropython ansi_escape_code ansi escape code sequence terminal io cursor position color font",
"author": "Stefan Kr\u00fcger",
"author_email": "git@s-light.eu",
"download_url": "https://files.pythonhosted.org/packages/a2/39/68be0ee45f0ff166af8facb7c95ee0cb2c2879267c3b033d1226c817f806/circuitpython-ansi-escape-code-1.2.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-ansi-escape-code/badge/?version=latest\n :target: https://circuitpython-ansi-escape-code.readthedocs.io/\n :alt: Documentation Status\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/s-light/CircuitPython_ansi_escape_code/workflows/Build%20CI/badge.svg\n :target: https://github.com/s-light/CircuitPython_ansi_escape_code/actions\n :alt: Build Status\n\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\nsimple helper library for common ANSI escape codes\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\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-ansi-escape-code/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-ansi-escape-code\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-ansi-escape-code\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 .env\n source .env/bin/activate\n pip3 install circuitpython-ansi-escape-code\n\n\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 pipx 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 ansi_escape_code\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nSee scripts in the examples directory of this repository.\n\n.. code-block:: python\n\n import ansi_escape_code as terminal\n print(\n terminal.ANSIColors.fg.lightblue\n + \"Hello \"\n + terminal.ANSIColors.fg.green\n + \"World \"\n + terminal.ANSIColors.fg.orange\n + \":-)\"\n + terminal.ANSIColors.reset\n )\n\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/s-light/CircuitPython_ansi_escape_code/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nDocumentation\n=============\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "simple helper library for common ANSI escape codes",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/s-light/CircuitPython_ansi_escape_code.git"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"ansi_escape_code",
"ansi",
"escape",
"code",
"sequence",
"terminal",
"io",
"cursor",
"position",
"color",
"font"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a23968be0ee45f0ff166af8facb7c95ee0cb2c2879267c3b033d1226c817f806",
"md5": "6664ea30abd94899207da557ec5b9b5c",
"sha256": "fe77be78784a46aedf96c063420b58529a1bb6008d5406611d42f8bf3fc59820"
},
"downloads": -1,
"filename": "circuitpython-ansi-escape-code-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "6664ea30abd94899207da557ec5b9b5c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33797,
"upload_time": "2023-08-28T20:47:55",
"upload_time_iso_8601": "2023-08-28T20:47:55.099032Z",
"url": "https://files.pythonhosted.org/packages/a2/39/68be0ee45f0ff166af8facb7c95ee0cb2c2879267c3b033d1226c817f806/circuitpython-ansi-escape-code-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-28 20:47:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "s-light",
"github_project": "CircuitPython_ansi_escape_code",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-ansi-escape-code"
}
JSON
