Installation

Base install

Install from PyPI with pip:

pip install prisma-flow

The base install supports:

  • JSON input and output
  • SVG rendering
  • standalone HTML rendering
  • Mermaid text rendering
  • PNG rendering through the bundled resvg Python dependency
  • validation reports
  • the prisma-flow CLI

Optional YAML support

pip install "prisma-flow[yaml]"

PNG support

PNG export is included in the base install and uses the pip-installable resvg backend. No Graphviz, Cairo, browser engine, Node renderer, or Mermaid CLI is required.

Minimal notebook environments may not include fonts. If PNG text is missing in Google Colab or another minimal container, install a basic font package before rendering:

apt-get update && apt-get install -y fonts-dejavu-core

Development install

conda env create -f conda/dev.yaml
conda activate prismaflow
poetry config virtualenvs.create false
poetry install --extras "dev yaml"

Run quality checks through Makim:

makim tests.linter
makim tests.unit
makim package.build
makim docs.build

Documentation tooling

The documentation site is built with Quarto. If you use Conda, install the development environment:

conda env create -f conda/dev.yaml
conda activate prismaflow

Build the docs:

quarto render docs