Skip to content

Installation

Requirements

  • Python 3.9 or newer
  • pip

Install from PyPI

bash
pip install MaTiSSe.py

With pipx (recommended for isolated installs):

bash
pipx install MaTiSSe.py

Verify the installation:

bash
matisse --version

Install from source

bash
git clone https://github.com/szaghi/MaTiSSe.git
cd MaTiSSe
pip install -e ".[dev]"

The .[dev] extras install pytest, pytest-cov, and ruff for local development.

Runtime dependencies

MaTiSSe depends on three Python packages, all installed automatically:

PackagePurpose
markdownMarkdown → HTML conversion
yattagHTML generation
pyyamlYAML theme and metadata parsing

Frontend assets (impress.js, MathJax, highlight.js) are loaded from CDN at runtime by default and require no local installation. Use --offline to copy them into the output directory instead.

Upgrading

bash
pip install --upgrade MaTiSSe.py

Platform notes

PlatformNotes
LinuxWorks on any modern distribution
macOSWorks with the standard Python installation
WindowsUse WSL (Windows Subsystem for Linux) or PowerShell with Python 3.9+

Troubleshooting

matisse: command not found

If you installed with pip install --user, ensure ~/.local/bin is on your PATH. pipx wires up the binary automatically.

Module import errors

Check Python version (python --version — must be 3.9+). If using a virtual environment, make sure it is activated before running pip install.

Reinstall from source

bash
git clone https://github.com/szaghi/MaTiSSe.git
cd MaTiSSe
pip install -e ".[dev]"