A Python library/script to reformat text to an aspect ratio.

Links

  1. License
  2. Download
  3. Usage
  4. Development Branch on Gitlab

License

The MIT License (MIT)

Copyright (c) 2017 Elliott Karpilovsky

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download

The text_reformat.zip file contains text_reformat.py for reformatting text based on an aspect ratio. It can also be invoked as a stand-alone script.

The MD5 sum is provided as a quick check that the file downloaded properly. However, it does not validate the download. Verify by using the signature.

Usage

The script text_reformat.py exports a library split_lines_by_ratio(text, char_width, line_height, ratio). Given a text string, the width and height of a character, and a ratio, returns multiple lines of text, such that the ratio of width to height is satisfied (to an approximation). It can also be called as a binary, where it reads from stdin and then outputs the results to stdout.

Flags

  • --aspect-ratio: Aspect ratio to aim for; defaults to 1.
  • --char-width: The width of a character; defaults to 1.
  • --char-height: The height of a chracter; defaults to 1.