Skip to content

davep/textual-canvas

Repository files navigation

textual-canvas

Being used for textual-mandelbrot An example of textual-canvas being used in a Textual application

GitHub Actions Workflow Status GitHub commits since latest release GitHub Issues or Pull Requests GitHub Release Date PyPI - License PyPI - Python Version PyPI - Version

Introduction

textual-canvas provides a simple terminal-based drawing canvas widget for use with Textual. Initially developed as a widget for building textual-mandelbrot, it made sense to spin it out into its own general-purpose library.

Installing

The package can be installed with pip or related tools, for example:

$ pip install textual-canvas

The library

The library provides one very simple widget for use in Textual: Canvas. This is a scrollable and focusable widget that can be used to colour "pixels", acting as a basic building block for drawing other things. The "pixels" themselves are half a character cell in height, hopefully coming out roughly square in most environments.

See the documentation for an introduction, a usage guide and detailed API documentation.