Installation

fountain-py is on PyPI, so install it with your usual package manager.

Requirements

  • Python 3.11 or higher (3.11, 3.12, 3.13, 3.14, 3.15 supported)

  • No external dependencies for core features

Install

pip install fountain-py

Or with uv:

uv add fountain-py

Verify the install:

python -c "import fountain; print('fountain-py ready')"

Install the Latest Unreleased Code

To install straight from the main branch on GitHub, ahead of the next release:

pip install git+https://github.com/MasonEgger/fountain-py.git

Development Installation

To contribute or work against a local checkout:

# Clone the repository
git clone https://github.com/MasonEgger/fountain-py.git
cd fountain-py

# Install the package in editable mode with the dev and docs dependency groups
uv sync --group docs

The dev and docs dependencies are dependency groups, not extras, so pip install -e ".[dev,docs]" does not install them. With pip 25.1 or newer, use pip install -e . --group dev --group docs instead.