{"id":29053074,"url":"https://github.com/s-light/circuitpython_ansi_escape_code","last_synced_at":"2025-06-27T01:03:20.866Z","repository":{"id":62562313,"uuid":"444700034","full_name":"s-light/CircuitPython_ansi_escape_code","owner":"s-light","description":"simple helper library for common ANSI escape codes","archived":false,"fork":false,"pushed_at":"2025-05-26T09:52:53.000Z","size":118,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-26T08:16:54.505Z","etag":null,"topics":["ansi","circuitpython","colors","cursor","escape","position","python3","sequence","terminal"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/s-light.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-05T07:08:12.000Z","updated_at":"2025-05-26T09:48:51.000Z","dependencies_parsed_at":"2024-11-13T12:12:08.738Z","dependency_job_id":"7bd87f02-76b7-4c17-9b12-3205df894076","html_url":"https://github.com/s-light/CircuitPython_ansi_escape_code","commit_stats":{"total_commits":11,"total_committers":1,"mean_commits":11.0,"dds":0.0,"last_synced_commit":"62843ab653e13100b4126a12c88451dddb2ae453"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/s-light/CircuitPython_ansi_escape_code","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s-light%2FCircuitPython_ansi_escape_code","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s-light%2FCircuitPython_ansi_escape_code/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s-light%2FCircuitPython_ansi_escape_code/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s-light%2FCircuitPython_ansi_escape_code/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/s-light","download_url":"https://codeload.github.com/s-light/CircuitPython_ansi_escape_code/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s-light%2FCircuitPython_ansi_escape_code/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262170236,"owners_count":23269604,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansi","circuitpython","colors","cursor","escape","position","python3","sequence","terminal"],"created_at":"2025-06-27T01:01:29.985Z","updated_at":"2025-06-27T01:03:20.803Z","avatar_url":"https://github.com/s-light.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"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\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/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\nsimple helper library for common ANSI escape codes\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython \u003chttps://github.com/adafruit/circuitpython\u003e`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle \u003chttps://circuitpython.org/libraries\u003e`_\nor individual libraries can be installed using\n`circup \u003chttps://github.com/adafruit/circup\u003e`_.\n\nInstalling from PyPI\n=====================\n.. note:: This library is not available on PyPI yet. Install documentation is included\n   as a standard element. Stay tuned for PyPI availability!\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI \u003chttps://pypi.org/project/circuitpython-ansi-escape-code/\u003e`_.\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 \u0026\u0026 cd project-name\n    python3 -m venv .venv\n    source .env/bin/activate\n    pip3 install circuitpython-ansi-escape-code\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 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\u003chttps://github.com/s-light/CircuitPython_ansi_escape_code/blob/HEAD/CODE_OF_CONDUCT.md\u003e`_\nbefore contributing to help this project stay welcoming.\n\nto locally check if your changes have a chance to pass the workflows run\n\n.. code-block:: shell\n\n    pre-commit run --all-files\n\nmultiple times. ;-)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs-light%2Fcircuitpython_ansi_escape_code","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fs-light%2Fcircuitpython_ansi_escape_code","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs-light%2Fcircuitpython_ansi_escape_code/lists"}