Installing WarMAC

Attention

WarMAC supports Python versions 3.11 to 3.14.

The primary method of installing WarMAC is by installing it through uv, though pipx may be used as well. This keeps WarMAC and its dependencies separate from your global Python packages. The option of building WarMAC yourself using uv also exists, however this is only recommended for development.

Using uv (or uvx)

The most basic method of installation is by installing as a uv tool like so:
$ uv tool install warmac
You can ensure that you’ve installed WarMAC correctly by calling its help page like so:
$ warmac --version
Once you’ve installed WarMAC, check out Usage for details on how to use WarMAC.

Using pipx

An alternative to installing with uv is pipx:
$ pipx install warmac
You can ensure that you’ve installed WarMAC correctly by calling its help page like so:
$ warmac --version
Once you’ve installed WarMAC, check out Usage for details on how to use WarMAC.

Using pip

Using pip alone to install WarMAC will work just as well, though dependencies will not be isolated. Installation can be done using the following command:
$ python -m pip install warmac
$ py -m pip install warmac
If you’re getting an error that python is not recognized as a command, try using the following instead:

python3 -m pip install warmac

You can ensure that you’ve installed WarMAC correctly by calling its help page like so:
$ warmac --version
Once you’ve installed WarMAC, check out Usage for details on how to use WarMAC.