Installation guide

Cabby supports Python 3.11 and 3.12. The commands below use Python 3.12. The MISP fork’s distribution name is misp-cabby. Python code imports cabby, and the command-line tools use their existing taxii-* names. Installing Cabby also installs misp-libtaxii (1.1.120 or later) for TAXII 1.0 and 1.1 XML messages. The fork provides the libtaxii Python module. See MISP/libtaxii.

Install uv

On macOS or Linux, run Astral’s installer in a terminal:

curl -LsSf https://astral.sh/uv/install.sh | sh

On Windows, run the installer in PowerShell:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Open a new terminal and check the installation:

uv --version

See the uv installation guide for package-manager alternatives. uv can download Python 3.12 automatically when a command requests it.

Install the TAXII command-line tools

Install the MISP fork from PyPI into an isolated tool environment.

uv tool install --python 3.12 misp-cabby
taxii-discovery --help

If your shell cannot find the command, run uv tool update-shell and open a new terminal. Use taxii-21 --help for the TAXII 2.1 command (see TAXII 2.1 guide). The installation also provides taxii-collections, taxii-poll, taxii-proxy, taxii-push and taxii-subscription.

Use Cabby in a Python project

From a uv project with a compatible Python requirement (for example, requires-python = ">=3.11,<3.13"), add the MISP fork and verify the import:

uv add misp-cabby
uv run python -c "from cabby import create_client; print(create_client.__name__)"

uv records the dependency in pyproject.toml and the resolved version in uv.lock.

Install with pip

With a Python 3.11 or 3.12 virtual environment active, run python -m pip install misp-cabby.

Switch from the original distribution

Both distributions provide the same cabby module and CLI commands. In a uv project that depends on cabby, run uv remove cabby before uv add misp-cabby. For a pip installation, run python -m pip uninstall cabby before installing misp-cabby. For a uv tool installation, run uv tool uninstall cabby first.

If your environment already contains the upstream libtaxii distribution, install Cabby in a fresh environment. Both libtaxii distributions own the same Python module and CLI files.

Install directly from GitHub

To run Cabby’s development version with dependencies from PyPI, use uv tool install --python 3.12 git+https://github.com/MISP/cabby.git for the CLI, or uv add "misp-cabby @ git+https://github.com/MISP/cabby.git" in a uv project. For an editable checkout, see Contributing and developing.

To try a Cabby checkout before its required libtaxii version is on PyPI, install the CLI from the checkout and give uv the matching MISP/libtaxii revision. This example uses the merged source for misp-libtaxii 1.1.120.

uv tool install --python 3.12 \
  --with "misp-libtaxii @ git+https://github.com/MISP/libtaxii.git@1c4bfa13731eb22c8fd6b674c2f5f0d48be72820" .
taxii-discovery --help

Versioning

Cabby uses major.minor.revision version numbers. The revision number identifies bug-fix releases.

Next steps

Continue with the User guide to see how to use Cabby.