Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 1.67 KB

index.rst

File metadata and controls

60 lines (43 loc) · 1.67 KB
Raw

Vesta

Vesta: A Vestaboard client library

Vesta is a Vestaboard client library for Python. It provides an API client and character encoding utilities.

Installation

Vesta requires Python 3.6 or later. It can be installed via PyPI:

$ python -m pip install vesta

It's only runtime dependency is the Requests library, which will be installed automatically.

API Client

.. autoclass:: vesta.Client
    :members:

Character Encoding

All Vestaboard characters (letters, numbers, symbols, and colors) are encoded as integer character codes. Vesta includes some useful routines for working with these character codes.

.. autoclass:: vesta.Color
    :show-inheritance:
    :members:
    :undoc-members:
    :exclude-members: ansi


.. autofunction:: vesta.encode

.. autofunction:: vesta.encode_row

.. autofunction:: vesta.encode_text


.. autofunction:: vesta.pprint

Message Posting

Messages can be posted (using :py:meth:`vesta.Client.post_message`) as either text strings or two-dimensional arrays of character codes representing the exact positions of characters on the board.

If text is specified, lines will be centered horizontally and vertically if possible. Character codes will be inferred for alphanumeric and punctuation, or can be explicitly specified in-line in the message with curly braces containing the character code (such as {5} or {65}).