Skip to content
Tabalyst is in alpha. This documentation describes version 0.2.1; commands and the JSON format may still change.

Install Tabalyst

Tabalyst needs Python 3.11, 3.12, 3.13 or 3.14. It is installed from PyPI with pip:

Terminal window
pip install tabalyst
tabalyst --version

The second command prints the installed version, for example 0.2.1. The sections below give the recommended steps for each system.

  1. Install Python 3.11 or later from python.org or the Microsoft Store. Then open a new PowerShell window and check the version:

    Terminal window
    py --version
  2. Create a virtual environment in your working folder. It keeps Tabalyst separate from other Python projects:

    Terminal window
    py -m venv .venv
  3. Install Tabalyst into this environment:

    Terminal window
    .venv\Scripts\python.exe -m pip install tabalyst
  4. Check the installation:

    Terminal window
    .venv\Scripts\python.exe -m tabalyst --version

To type tabalyst directly, activate the environment first in each new PowerShell window:

Terminal window
.venv\Scripts\Activate.ps1
tabalyst --version

If PowerShell refuses to run Activate.ps1 because script execution is disabled, keep using .venv\Scripts\python.exe -m tabalyst instead: it accepts exactly the same commands.

Terminal window
python3 -m venv .venv
source .venv/bin/activate
python -m pip install tabalyst
tabalyst --version

To install the tabalyst command once for your user account instead, use pipx:

Terminal window
pipx install tabalyst

Run the install command again with --upgrade:

Terminal window
python -m pip install --upgrade tabalyst

On Windows without an activated environment:

Terminal window
.venv\Scripts\python.exe -m pip install --upgrade tabalyst
  • tabalyst is not recognized: the environment is not activated, or the Python scripts folder is not on your PATH. Use python -m tabalyst (or .venv\Scripts\python.exe -m tabalyst on Windows): python -m tabalyst accepts the same commands as tabalyst.
  • py is not recognized on Windows: Python is not installed, or was installed without the launcher. Reinstall it from python.org.
  • Unsupported Python version: pip refuses to install Tabalyst on Python 3.10 or earlier. Install a supported version and recreate the environment.

Create your first report.