Installation

Caution

Wheels are provided for Linux, MacOS and Windows x86-64, but other machines will have to build the wheel from the source distribution. Building pysylph involves compiling sylph, which requires a Rust compiler to be available on the local machine.

PyPi

pysylph 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 pysylph either from a wheel if one is available, or from source after compiling the Rust code :

$ pip install --user pysylph

Arch User Repository

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

Piwheels

PySylph works on Raspberry Pi computers, and pre-built wheels are compiled for armv7l on piwheels. Run the following command to install these instead of compiling from source:

$ pip3 install pysylph --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):

$ pip install -U git+https://github.com/althonos/pysylph

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

If you do not want to use pip, you can still clone the repository and use build and installer manually:

$ git clone --recursive https://github.com/althonos/pysylph
$ cd pysylph
$ 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.