Installation#
Note
Wheels are provided for x86-64 Linux and MacOS, as well as Aarch64 Linux
and MacOS, but other machines will have to build the wheel from the source
distribution. Building pytantan involves compiling the Tantan C++ code,
which requires a C compiler to be available on the local machine.
PyPi#
pytantan is hosted on GitHub, but the easiest way to install it is to download
the latest release from its PyPi repository.
It will install all build dependencies then install pytantan
either from a wheel if one is available, or from source after compiling the
Cython code :
$ pip install --user pytantan
Arch User Repository#
A package recipe for Arch Linux can be found in the Arch User Repository under the name python-pytantan. It will always match the latest release from PyPI.
Steps to install on ArchLinux depend on your AUR helper
(yaourt, aura, yay, etc.). For aura, you’ll need to run:
$ aura -A python-pytantan
Piwheels#
pytantan is compatible with Raspberry Pi computers, and pre-built
wheels are compiled for armv7l platforms on piwheels.
Run the following command to install these instead of compiling from source:
$ pip3 install pytantan --extra-index-url https://www.piwheels.org/simple
Check the piwheels documentation for more information.
GitHub + pip#
If, for any reason, you prefer to download the library from GitHub, you can clone the repository and install the repository by running (with the admin rights):
$ git clone --recursive https://github.com/althonos/pytantan
$ pip install --user ./pytantan
Caution
Keep in mind this will install always try to install the latest commit, which may not even build, so consider using a versioned release instead.
GitHub + setuptools#
If you do not want to use pip, you can still clone the repository and
run the setup.py file manually, although you will need to install the
build dependencies (mainly Cython):
$ git clone --recursive https://github.com/althonos/pytantan
$ cd pytantan
$ python setup.py build_ext
# python setup.py install
Danger
Installing packages without pip is strongly discouraged, as they can
only be uninstalled manually, and may damage your system.