Installing WarMAC#
Attention
WarMAC only supports Python versions 3.8 to 3.12. There are currently no plans to add support to Python 3.7
WarMAC’s only dependency is urllib3 ≥2.0.4,<3.0.0
WarMAC can be installed in a variety of ways, all of which can be found on
this page. It is recommended that you install WarMAC using pipx, which keeps WarMAC and its dependencies
separate from your global Python version. However, using pip alone will work
just as well. The option of building WarMAC yourself using Poetry also
exists, however it is recommended for this to not be done.
Using pipx#
Installing WarMAC using pipx can be done by running the following command in
the terminal:
$ python -m pipx install warmac
$ py -m 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#
Installing WarMAC using pip can be done by running the following command in
the terminal:
$ python -m pip install warmac
$ py -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.
Using Poetry#
Warning
Modifying the dependency pins of WarMAC could result in errors. It’s recommended to keep the dependency pins as is to maintain stability.
WarMAC can also be installed using Poetry
either through the provided
poetry.lock file (recommended) or by building
a lock of your own.$ git clone https://github.com/Eutropios/WarMAC.git ./some/directory
WarMAC can then be built by navigating to the directory you cloned WarMAC
into, and running the
poetry build and poetry install commands.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.