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.

TopMark currently supports Python 3.10-3.15. Python 3.10 is in its temporary EOL compatibility window; use Python 3.11 or later for new or security-sensitive deployments. See the Python support policy for the supported-version lifecycle and transition dates.

Read the canonical installation guide on GitHub:

• https://github.com/shutterfreak/topmark/blob/main/INSTALL.md

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:

• Getting started

Upgrade an existing repository¶

TopMark major releases can change CLI, configuration, and machine-output contracts. Before upgrading, identify the installed version and follow every major-version guide your repository crosses.

Choose the applicable version-boundary guide:

• Upgrading TopMark

Further reading¶

• Getting started
• Usage documentation
• Configuration overview
• CI and validation
• Contributing