semvec/pypi-packages huggingface dataset:
styled-prose 1.0.0
Generate images and thumbnails based on bitmap transformations of rendered prose
License: BSD-3-Clause
Requires Python: >=3.8
Keywords: prose text writing pdf typography fonts art image render pillow pdf2image tgf the-glass-files

# styled-prose

![GitHub Workflow Status](https://raster.shields.io/github/actions/workflow/status/thearchitector/styled-prose/ci.yaml?label=tests&style=flat-square)
![PyPI - Downloads](https://raster.shields.io/pypi/dw/styled-prose?style=flat-square)
![GitHub](https://raster.shields.io/github/license/thearchitector/styled-prose?style=flat-square)

Generate images and thumbnails based on bitmap transformations of rendered prose.

Documentation: <https://styledprose.thearchitector.dev>.

Tested support on Python 3.8, 3.9, 3.10, 3.11, and 3.12.

```sh
$ pdm add styled-prose
# or
$ pip install --user styled-prose
```

## Example

The following stylesheet is a super simple example that overrides the `default` style's font size and family.

```toml
# stylesheet.toml

[[fonts]]
font_name = "EB Garamond"
from_google_fonts = true

[[styles]]
name = "default"
font_size = 14
font_name = "EB Garamond"
```

Using that stylesheet, and some basic prose, you can generate an image. The requested font family `EB Garamond` and its license are downloaded from Google Fonts and cached automatically; subsequent generations use those cached fonts.

```python
from PIL import Image
from styled_prose import StyledProseGenerator

text: str = """
This is normal.

<i>This is italicized.</i>

<b>This is bold.</b>

<i><b>This is bold and italicized.</b></i>

<u>This is underlined.</u>

<strike>This is struck from the record.</strike>
"""
random.seed(771999)

generator: StyledProseGenerator = StyledProseGenerator("stylesheet.toml")
img: Image.Image = generator.create_jpg(
    text,
    angle=-2.5, # optional; an angle by which to rotate the image
    thumbnail=(210, 210), # optional; the dimensions of a random thumbnail
)

img.save("prose.jpg", quality=95)
```

This above code produces the following image:

![example rendering](/docs/simple.jpg)