Installing¶
Wavelink 4 currently supports the following Python versions:
Python Version |
Status |
Notes |
|---|---|---|
<= 3.11 |
Not Supported | Versions 3.11 or under are not supported. |
3.12, 3.13, 3.14 |
Fully Supported | These versions have been tested and are supported. |
3.15 |
Check Notes | May require custom index |
Commands¶
UV¶
uv add wavelink
pip¶
pip install -U wavelink
Extra and Optional Dependencies¶
To use certain optional features of Wavelink you will have to install the required packages needed to run them. The following commands can be used to install Wavelink with optional features:
For development purposes:
pip install -U wavelink[dev]
For documentation purposes:
pip install -U wavelink[docs]
Custom Index¶
Using Wavelink with Python >= 3.15 may require the use of a custom pip index.
The index allows pip to fetch pre-built wheels for some dependencies that may require build-tools for C/C++ due to not having released their own wheels for recent versions of Python.
Usually with time, dependencies will eventually release wheels for new Python releases. For convenience we provide an index thanks to Abstract Umbra
To install with prebuilt wheels:
pip install -U wavelink --extra-index-url https://abstractumbra.github.io/pip/
Installation Issues¶
Make sure you have the latest version of Python installed, or if you prefer, a Python version of 3.12 or greater. If you have any other issues feel free to search for duplicates and then create a new issue on GitHub with as much detail as possible. Including providing the output of pip, your OS details and Python version.