textual-pyfiglet


Nametextual-pyfiglet JSON
Version 0.10.0 PyPI version JSON
download
home_pageNone
SummaryA Widget implementation of PyFiglet for Textual
upload_time2025-07-24 07:27:14
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT
keywords ascii ascii-art figlet pyfiglet python textual tui widget
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![textual-pyfiglet-banner-transparent](https://github.com/user-attachments/assets/4391ddc7-98a6-474b-8c45-603567d9dad0)

# Textual-Pyfiglet

![badge](https://img.shields.io/badge/linted-Ruff-blue?style=for-the-badge&logo=ruff)
![badge](https://img.shields.io/badge/formatted-black-black?style=for-the-badge)
![badge](https://img.shields.io/badge/type_checked-MyPy_(strict)-blue?style=for-the-badge&logo=python)
![badge](https://img.shields.io/badge/Type_checked-Pyright_(strict)-blue?style=for-the-badge&logo=python)
![badge](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)
![badge](https://img.shields.io/badge/framework-Textual-blue?style=for-the-badge)

Textual-PyFiglet is an implementation of [PyFiglet](https://github.com/pwaller/pyfiglet) for [Textual](https://github.com/Textualize/textual).

It provides a `FigletWidget` which makes it easy to add ASCII banners with colors and animating gradients.

*This library is related to [Rich-Pyfiglet](https://github.com/edward-jazzhands/rich-pyfiglet), as well as utilizes [Textual-Coloromatic](https://github.com/edward-jazzhands/textual-coloromatic) to provide the Color/animation abilities.*

## Features

- Full integration of Pyfiglet into Textual. Change the text or the font in real time - This can be connected to user input or modified programmatically.
- Color system built on Textual's color system. Thus, it can display any color in the truecolor/16-bit spectrum,
and can take common formats such as hex code and RGB, or just a huge variety of named colors.
- Make a gradient automatically between any two colors.
- Animation system that's simple to use. Just make your gradient and toggle it on/off. It can also be started
or stopped in real-time.
- The auto-size mode will re-size the widget with the new rendered ASCII output in real-time. It can also wrap
to the parent container and be made to resize with your terminal.
- Animation settings can be modified to get different effects. Set a low amount of colors and a low speed for a
very old-school retro look, set it to a high amount of colors and a high speed for a very smooth animation.
- The fonts are type-hinted to give you auto-completion in your code editor, eliminating the need to manually
check what fonts are available.
- Included demo app to showcase the features.

## Demo App

If you have uv or Pipx, you can immediately try the demo app:

```sh
uvx textual-pyfiglet 
```

```sh
pipx run textual-pyfiglet
```

## Documentation

### [Click here for documentation](https://edward-jazzhands.github.io/libraries/textual-pyfiglet/docs/)

## Video

https://github.com/user-attachments/assets/29f166b1-3680-4f9a-81cc-717ad6007fad

## Questions, Issues, Suggestions?

Use the [issues](https://github.com/edward-jazzhands/textual-pyfiglet/issues) section for bugs or problems, and post ideas or feature requests on the [TTY group discussion board](https://github.com/orgs/ttygroup/discussions).

## Thanks and Copyright

Both Textual-Pyfiglet and the original PyFiglet are under MIT License. See LICENSE file.

FIGlet fonts have existed for a long time, and many people have contributed over the years.

Original creators of FIGlet:  
[https://www.figlet.org](https://www.figlet.org)

The PyFiglet creators:  
[https://github.com/pwaller/pyfiglet](https://github.com/pwaller/pyfiglet)

Textual:  
[https://github.com/Textualize/textual](https://github.com/Textualize/textual)

And finally, thanks to the many hundreds of people that contributed to the fonts collection.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "textual-pyfiglet",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "ascii, ascii-art, figlet, pyfiglet, python, textual, tui, widget",
    "author": null,
    "author_email": "edward-jazzhands <ed.jazzhands@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/55/f5/0988f62e6fc75ee49fb9656b04943592378bd4a0ae4774e0d5ec8e14d32a/textual_pyfiglet-0.10.0.tar.gz",
    "platform": null,
    "description": "![textual-pyfiglet-banner-transparent](https://github.com/user-attachments/assets/4391ddc7-98a6-474b-8c45-603567d9dad0)\n\n# Textual-Pyfiglet\n\n![badge](https://img.shields.io/badge/linted-Ruff-blue?style=for-the-badge&logo=ruff)\n![badge](https://img.shields.io/badge/formatted-black-black?style=for-the-badge)\n![badge](https://img.shields.io/badge/type_checked-MyPy_(strict)-blue?style=for-the-badge&logo=python)\n![badge](https://img.shields.io/badge/Type_checked-Pyright_(strict)-blue?style=for-the-badge&logo=python)\n![badge](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)\n![badge](https://img.shields.io/badge/framework-Textual-blue?style=for-the-badge)\n\nTextual-PyFiglet is an implementation of [PyFiglet](https://github.com/pwaller/pyfiglet) for [Textual](https://github.com/Textualize/textual).\n\nIt provides a `FigletWidget` which makes it easy to add ASCII banners with colors and animating gradients.\n\n*This library is related to [Rich-Pyfiglet](https://github.com/edward-jazzhands/rich-pyfiglet), as well as utilizes [Textual-Coloromatic](https://github.com/edward-jazzhands/textual-coloromatic) to provide the Color/animation abilities.*\n\n## Features\n\n- Full integration of Pyfiglet into Textual. Change the text or the font in real time - This can be connected to user input or modified programmatically.\n- Color system built on Textual's color system. Thus, it can display any color in the truecolor/16-bit spectrum,\nand can take common formats such as hex code and RGB, or just a huge variety of named colors.\n- Make a gradient automatically between any two colors.\n- Animation system that's simple to use. Just make your gradient and toggle it on/off. It can also be started\nor stopped in real-time.\n- The auto-size mode will re-size the widget with the new rendered ASCII output in real-time. It can also wrap\nto the parent container and be made to resize with your terminal.\n- Animation settings can be modified to get different effects. Set a low amount of colors and a low speed for a\nvery old-school retro look, set it to a high amount of colors and a high speed for a very smooth animation.\n- The fonts are type-hinted to give you auto-completion in your code editor, eliminating the need to manually\ncheck what fonts are available.\n- Included demo app to showcase the features.\n\n## Demo App\n\nIf you have uv or Pipx, you can immediately try the demo app:\n\n```sh\nuvx textual-pyfiglet \n```\n\n```sh\npipx run textual-pyfiglet\n```\n\n## Documentation\n\n### [Click here for documentation](https://edward-jazzhands.github.io/libraries/textual-pyfiglet/docs/)\n\n## Video\n\nhttps://github.com/user-attachments/assets/29f166b1-3680-4f9a-81cc-717ad6007fad\n\n## Questions, Issues, Suggestions?\n\nUse the [issues](https://github.com/edward-jazzhands/textual-pyfiglet/issues) section for bugs or problems, and post ideas or feature requests on the [TTY group discussion board](https://github.com/orgs/ttygroup/discussions).\n\n## Thanks and Copyright\n\nBoth Textual-Pyfiglet and the original PyFiglet are under MIT License. See LICENSE file.\n\nFIGlet fonts have existed for a long time, and many people have contributed over the years.\n\nOriginal creators of FIGlet:  \n[https://www.figlet.org](https://www.figlet.org)\n\nThe PyFiglet creators:  \n[https://github.com/pwaller/pyfiglet](https://github.com/pwaller/pyfiglet)\n\nTextual:  \n[https://github.com/Textualize/textual](https://github.com/Textualize/textual)\n\nAnd finally, thanks to the many hundreds of people that contributed to the fonts collection.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Widget implementation of PyFiglet for Textual",
    "version": "0.10.0",
    "project_urls": {
        "Changelog": "https://github.com/edward-jazzhands/textual-pyfiglet/blob/master/Changelog.md",
        "Repository": "https://github.com/edward-jazzhands/textual-pyfiglet"
    },
    "split_keywords": [
        "ascii",
        " ascii-art",
        " figlet",
        " pyfiglet",
        " python",
        " textual",
        " tui",
        " widget"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "72a8db17627f3ae79b0adcd7e0e2037d12adb87d26f9bda9035d6457e064b207",
                "md5": "3d477c941bb426a68eb7fb3dfab5f4cd",
                "sha256": "c93442c48b23eae5000a16db77a46301b7b4d2f49f3b3fb62f28c3eafc14ee4c"
            },
            "downloads": -1,
            "filename": "textual_pyfiglet-0.10.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3d477c941bb426a68eb7fb3dfab5f4cd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 22043,
            "upload_time": "2025-07-24T07:27:13",
            "upload_time_iso_8601": "2025-07-24T07:27:13.158287Z",
            "url": "https://files.pythonhosted.org/packages/72/a8/db17627f3ae79b0adcd7e0e2037d12adb87d26f9bda9035d6457e064b207/textual_pyfiglet-0.10.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "55f50988f62e6fc75ee49fb9656b04943592378bd4a0ae4774e0d5ec8e14d32a",
                "md5": "db6e259fbac4638ef1fb38e4190821f4",
                "sha256": "3d9233ee3686ef7fee2d562e1cfeef2ecdf54133c8549235a0cee2ee591db16e"
            },
            "downloads": -1,
            "filename": "textual_pyfiglet-0.10.0.tar.gz",
            "has_sig": false,
            "md5_digest": "db6e259fbac4638ef1fb38e4190821f4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 103619,
            "upload_time": "2025-07-24T07:27:14",
            "upload_time_iso_8601": "2025-07-24T07:27:14.408016Z",
            "url": "https://files.pythonhosted.org/packages/55/f5/0988f62e6fc75ee49fb9656b04943592378bd4a0ae4774e0d5ec8e14d32a/textual_pyfiglet-0.10.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-24 07:27:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "edward-jazzhands",
    "github_project": "textual-pyfiglet",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "textual-pyfiglet"
}
        
Elapsed time: 0.43732s