Skip to content

Installation guide

This page summarizes TopMark installation and development-environment setup.

The canonical installation and contributor setup guide lives at the repository root in INSTALL.md.

Read the canonical installation guide on GitHub:

If you are viewing this from the published documentation site, the link above opens the same document in the repository with GitHub-native rendering and navigation.

Install from PyPI

pip install topmark

Verify the CLI:

topmark version

For a guided first setup, continue with:

Upgrade from TopMark 0.11.x or earlier

TopMark 1.0 includes breaking changes to:

  • CLI options and reporting behavior;
  • pre-commit hook arguments;
  • TOML configuration structure and runtime policy settings;
  • TEXT, Markdown, JSON, and NDJSON output contracts.

Before upgrading an existing repository, review:

Further reading