Skip to content

Installation

Requirements

  • Python 3.10 or newer
  • uv (recommended) or pip

Install from PyPI

pip install pyreveal

Or with uv:

uv add pyreveal

Install from source

Clone the repository and initialize the reveal.js submodule:

git clone https://github.com/tavallaie/pyreveal.git
cd pyreveal
git submodule update --init --recursive
uv sync --dev

reveal.js 6.x ships pre-built dist/ files in the submodule, so you do not need Node.js to use PyReveal.

Verify the install

uv run python -c "from pyreveal import Presentation, Slide, Theme; print(Theme.DRACULA.value)"

Next step

Quick start to build your first deck.