Installation

Note

Wheels are provided for x86-64 Linux, MacOS, and Windows, as well as Aarch64 Linux and MacOS, but other machines will have to build the wheel from the source distribution. Building pyswrd involves compiling SWORD, which requires a C++ compiler with C++17 features to be available on the local machine.

PyPi

pyswrd 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 dependencies then install pyswrd either from a wheel if one is available, or from source after compiling the Cython code :

$ pip install --user pyswrd

Arch User Repository

A package recipe for Arch Linux can be found in the Arch User Repository under the name python-pyswrd. 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-pyswrd

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):

$ pip install --user git+https://github.com/althonos/pyswrd

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 + installer

If you do not want to use pip, you can still clone the repository and build the package manually, although you will need to install the build dependencies (mainly Cython and PyOpal):

$ git clone --recursive https://github.com/althonos/pyswrd
$ cd pyopal
$ python -m build .
# python -m installer dist/*.whl

Danger

Installing packages without pip is strongly discouraged, as they can only be uninstalled manually, and may damage your system.