Skip to content

Installation

Requires Python 3.11+.

Install from PyPI

For the command-line interface and SVG output:

python -m pip install tartan-maker

For PNG export through CairoSVG:

python -m pip install "tartan-maker[png]"

Check the installed CLI:

tartan-maker --version
tartan-maker --help

Native logging dependency: spdlog is required and PyPI does not provide prebuilt wheels for every supported Python/platform combination. Where no compatible wheel exists, pip builds it from source; a working C++ compiler and Python build tools may be necessary (for example, Xcode Command Line Tools on macOS or MSVC Build Tools on Windows). The release CI checks installation on hosted Linux, macOS, and Windows runners.

The package installs the tartan-maker command. No Python source checkout is needed. The repository's examples/ directory is not bundled in the installed wheel; download examples from GitHub or write your own YAML.

Development checkout

From the repository root:

python -m pip install -e ".[dev,png]"

Documentation tools

python -m pip install mkdocs mkdocs-material "mkdocstrings[python]"
mkdocs serve

Use mkdocs build --strict to build the static site.