vpype-text

IMPORTANT NOTE: the functionality of this plug-in as been integrated (and expended upon) in vpype. This plug-in should no longer be used, and uninstalled if present. This repository is now archived.

Plug-in for vpype to generate text with stroke fonts (a.k.a. Hershey fonts). This plug-in is implemented as a thin wrapper on Michael Fogleman's axi project.

Currently, a variety of fonts are supported, as well as control on alignment (left, right, center). Multi-line text or wrapping is not (yet?) supported.

Examples

Basic use:

vpype text "Hello world!" show

Control position and alignment:

vpype text --position 0 0 "Hello world" text --position 0 1cm --align right "dlrow olleH" text --position 0 2cm --align center "Hello olleH" show

Change text font and size:

vpype text "Default font and size" text -p 0 1cm --font gothiceng -s 12px "Custom font and size" show

Installation

See the installation instructions for information on how to install vpype.

Existing `vpype` installation

Use this method if you have an existing vpype installation (typically in an existing virtual environment) and you want to make this plug-in available. You must activate your virtual environment beforehand.

$ pip install git+https://github.com/abey79/vpype-text.git#egg=vpype-text

Check that your install is successful:

$ vpype --help
Usage: vpype [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Options:
  -v, --verbose
  -I, --include PATH  Load commands from a command file.
  --help              Show this message and exit.

Commands:
[...]
  Plugins:
    text
[...]

Stand-alone installation

Use this method if you want to edit this project. First, clone the project:

$ git clone https://github.com/abey79/vpype-text.git
$ cd vpype-text

Create a virtual environment:

$ python3 -m venv venv
$ source venv/bin/activate
$ pip install --upgrade pip

Install vpype-text and its dependencies (including vpype):

$ pip install -e .

Check that your install is successful:

$ vpype --help
Usage: vpype [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Options:
  -v, --verbose
  -I, --include PATH  Load commands from a command file.
  --help              Show this message and exit.

Commands:
[...]
  Plugins:
    text
[...]

Documentation

The complete plug-in documentation is available directly in the CLI help:

$ vpype text --help

License

See the LICENSE file for details.

abey79/vpype-text