ANSIController


NameANSIController JSON
Version 1.1.2 PyPI version JSON
download
home_pagehttps://github.com/jo0x01/ansicontroller
SummaryBasic Python Module to control & color & style text in terminal
upload_time2025-09-08 23:23:14
maintainerNone
docs_urlNone
authorJoOx01
requires_pythonNone
licenseMIT
keywords cmd ansi terminal ansi_terminal ansicontrol ansicontroller asni ansicontroller ansi_escape
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![App Icon](ANSIController.ico)

# ANSI Controller

![PyPi](https://img.shields.io/badge/-PyPi-blue.svg?logo=pypi&labelColor=555555&style=for-the-badge)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)](LICENSE)

An Python module to control cursor movement, apply colors, and style text in the terminal using ANSI escape codes.

---

## Features
- Cursor control: move up, down, left, right, or to specific coordinates.
- Text colorization: standard, bright, RGB, and HEX colors.
- Styling: **bold**, *italic*, underline, blink, reverse, hidden, strikethrough.
- Customizable progress bars (multi-progress supported).
- Terminal clearing options (partial or full).
- Cross-platform: Windows, Linux, Termux (limited features).

---

## Installation
### Windows
```bash
pip install --upgrade ANSIController
```

### Linux & Termux
```bash
pip3 install --upgrade ANSIController
```

---

## Quick Start
```python
from ANSIController import Terminal

terminal = Terminal()

# Move cursor up 3 lines
terminal.move_to_up(steps=3)

# Colorize text
text = "[rB]Hello, Red Bold![0]"
print(terminal.colorize(text, "[]"))

# Hide and show cursor
terminal.hide_cursor()
terminal.show_cursor()
```

---

## Documentation
- **[Full Documentation](docs.md)** – Detailed API reference and usage.
- **[Showcase](showcase.md)** – Extended screenshots, demos, and visual examples.

---

## Screenshots
Essential visuals for quick reference:

![Progress Bar](ANSIController/tests/test_progress.gif)

---

## Notes
- Works only in terminals supporting **ANSI escape codes**.
- Some Termux features may require root privileges.
- Designed for scripting, automation, and learning.

---

## License
This project is licensed under the **MIT License**.

**Copyright (c) 2023 JoOx01**

---

## Contributing & Issues
Found a bug? Have a feature request? Open an
[issue](https://github.com/Jo0X01/ANSIController/issues) or submit a PR!

---

## Tests
- **Windows 7/10/11:** Fully supported
- **Linux:** Mostly supported
- **Termux:** Limited features, some require root access

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jo0x01/ansicontroller",
    "name": "ANSIController",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "cmd, ansi, terminal, ansi_terminal, ANSIControl, ANSIController, ASNI, ansicontroller, ansi_escape",
    "author": "JoOx01",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/1c/32/932b5407a8b28d95622d630ae157d7c576904d19b5fc4354e615da71cfeb/ansicontroller-1.1.2.tar.gz",
    "platform": null,
    "description": "![App Icon](ANSIController.ico)\r\n\r\n# ANSI Controller\r\n\r\n![PyPi](https://img.shields.io/badge/-PyPi-blue.svg?logo=pypi&labelColor=555555&style=for-the-badge)\r\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)](LICENSE)\r\n\r\nAn Python module to control cursor movement, apply colors, and style text in the terminal using ANSI escape codes.\r\n\r\n---\r\n\r\n## Features\r\n- Cursor control: move up, down, left, right, or to specific coordinates.\r\n- Text colorization: standard, bright, RGB, and HEX colors.\r\n- Styling: **bold**, *italic*, underline, blink, reverse, hidden, strikethrough.\r\n- Customizable progress bars (multi-progress supported).\r\n- Terminal clearing options (partial or full).\r\n- Cross-platform: Windows, Linux, Termux (limited features).\r\n\r\n---\r\n\r\n## Installation\r\n### Windows\r\n```bash\r\npip install --upgrade ANSIController\r\n```\r\n\r\n### Linux & Termux\r\n```bash\r\npip3 install --upgrade ANSIController\r\n```\r\n\r\n---\r\n\r\n## Quick Start\r\n```python\r\nfrom ANSIController import Terminal\r\n\r\nterminal = Terminal()\r\n\r\n# Move cursor up 3 lines\r\nterminal.move_to_up(steps=3)\r\n\r\n# Colorize text\r\ntext = \"[rB]Hello, Red Bold![0]\"\r\nprint(terminal.colorize(text, \"[]\"))\r\n\r\n# Hide and show cursor\r\nterminal.hide_cursor()\r\nterminal.show_cursor()\r\n```\r\n\r\n---\r\n\r\n## Documentation\r\n- **[Full Documentation](docs.md)** \u2013 Detailed API reference and usage.\r\n- **[Showcase](showcase.md)** \u2013 Extended screenshots, demos, and visual examples.\r\n\r\n---\r\n\r\n## Screenshots\r\nEssential visuals for quick reference:\r\n\r\n![Progress Bar](ANSIController/tests/test_progress.gif)\r\n\r\n---\r\n\r\n## Notes\r\n- Works only in terminals supporting **ANSI escape codes**.\r\n- Some Termux features may require root privileges.\r\n- Designed for scripting, automation, and learning.\r\n\r\n---\r\n\r\n## License\r\nThis project is licensed under the **MIT License**.\r\n\r\n**Copyright (c) 2023 JoOx01**\r\n\r\n---\r\n\r\n## Contributing & Issues\r\nFound a bug? Have a feature request? Open an\r\n[issue](https://github.com/Jo0X01/ANSIController/issues) or submit a PR!\r\n\r\n---\r\n\r\n## Tests\r\n- **Windows 7/10/11:** Fully supported\r\n- **Linux:** Mostly supported\r\n- **Termux:** Limited features, some require root access\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Basic Python Module to control & color & style text in terminal",
    "version": "1.1.2",
    "project_urls": {
        "Homepage": "https://github.com/jo0x01/ansicontroller"
    },
    "split_keywords": [
        "cmd",
        " ansi",
        " terminal",
        " ansi_terminal",
        " ansicontrol",
        " ansicontroller",
        " asni",
        " ansicontroller",
        " ansi_escape"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7c6cbd32ec7e85b82aa5a35de1c8c45d5d0241b709c637dd1977c197282a5a4a",
                "md5": "b77ddab0494b18df00554432d9c16952",
                "sha256": "586575c449def915edf28a29f85abf2e11cbed0005e9f7cd9ab68db0583ca156"
            },
            "downloads": -1,
            "filename": "ansicontroller-1.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b77ddab0494b18df00554432d9c16952",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 20918,
            "upload_time": "2025-09-08T23:23:13",
            "upload_time_iso_8601": "2025-09-08T23:23:13.111416Z",
            "url": "https://files.pythonhosted.org/packages/7c/6c/bd32ec7e85b82aa5a35de1c8c45d5d0241b709c637dd1977c197282a5a4a/ansicontroller-1.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1c32932b5407a8b28d95622d630ae157d7c576904d19b5fc4354e615da71cfeb",
                "md5": "cd33e137380cb87d4366865bc2b3ad2a",
                "sha256": "b831c72cccc07bdcf8e772279f13ff7e0557e36ee15ba8d614490ecf7cbd6e9d"
            },
            "downloads": -1,
            "filename": "ansicontroller-1.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "cd33e137380cb87d4366865bc2b3ad2a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 18210,
            "upload_time": "2025-09-08T23:23:14",
            "upload_time_iso_8601": "2025-09-08T23:23:14.079070Z",
            "url": "https://files.pythonhosted.org/packages/1c/32/932b5407a8b28d95622d630ae157d7c576904d19b5fc4354e615da71cfeb/ansicontroller-1.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-08 23:23:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jo0x01",
    "github_project": "ansicontroller",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "ansicontroller"
}
        
Elapsed time: 1.40869s