lavalink-rs bindings for Python

lavasnek_rs

Dev Docs: Main Site | Fallback: GitHub Pages
GitHub repo
GitLab repo

Using the library

The library is available on PyPi, and you can install it via pip install lavasnek_rs --pre -U --user

To install a developement release of the library, go to the Actions tab on GitHub, select the latest commit, and download the Artifact that suits your needs. Extract the artifact, and install the .whl file with pip install -U --user filename.whl

Then you should be able to import the library and use it!

Building and Running the hikari example

If you wanna build the project from source, (for contributing, compiling to a different architecture than x86_64 or for python 3.10) you will need:

# It is highly recommended that you use Linux, either natively or with WSL2

# You will need python 3.6 or newer.
sudo apt install python3-pip curl # for Ubuntu, Debian or derivatives
sudo pacman -S python3-pip curl # for Arch, EndeavourOS, Manjaro or derivatives

# You will also need the rust programming language.
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# You will also need a lavalink server running.
# see https://github.com/freyacodes/Lavalink or use docker
docker run --name lavalink -p 2333:2333 -d -v $HOME/application.yml:/opt/Lavalink/application.yml fredboat/lavalink:dev

Then to run the project, just run all of this. Only the last 2 are repeatable.

python -m venv .env
source .env/bin/activate
pip install maturin

maturin develop
python examples/pure_hikari_basic_queue/bot.py

Sorry for breaking them, I should have tested everything first 😖

mypy and flake8 both passed, but if there's any changes you'd like me to make I can :)

general improvements including: -fixing a lot of mypy and flake8 errors with hikari's config (not using hikari's flake8 plugins) -running black and isort with hikari's configj (not using force_single_line in isort config) -addding

if __name__ == "__main__":
    if os.name != "nt":
        import uvloop

        uvloop.install()

to main.py and bot.py -importing lavalink password from consts instead of getting is from environment variables again

__init__.pyi:

...
class ConnectionInfo:
    guild_id: int
    channel_id: int
    endpoint: int
    token: str
    session_id: str
...

But real type is dict

Maybe you meant an object, but you made a dictionary If you want dict, you can use TypedDict

poetry add typing_extensions

from typing_extensions import TypedDict

...
class ConnectionInfo(TypedDict):
    guild_id: int
    channel_id: int
    endpoint: int
    token: str
    session_id: str

This PR adds missing typehints for missing decode_track function of the Lavalink Class and also adds missing typehints for missing track_stuck event of the LavalinkEventHandler class

This is to support the new M1 macs, and people hosting their bots on ARM systems like the Raspberry Pi or Android Phones.

[x] Build for 64 bit aarch64-unknown-linux-gnu and aarch64-apple-darwin
[ ] Build for 32 bit armv7-unknown-linux-gnueabihf

enhancement

This was replaced by search.js as of pdoc 8.0.0

Just a random note if anybody cares but personally I'm using a small script to still build the json search index in the projects where i'm using pdoc 8.0.0 since I still consume it for 3rd party search (e.g. bot search commands). This is pretty easy to achieve since Pdoc hasn't actually changed the format its using for the search index, its just compiling it fully instead of to am middle-ground stage

This pull request adds an example using the tanjun command handler, with both message and slash commands.

I have also applied some fixes to the typing in lavasnek_rs.pyi and one change inside the rust src.

Add __new__ to LavalinkBuilder in .pyi.
Change event_handler type from LavalinkEventHandler to object for LavalinkBuilder.build because LavalinkEventHandler is not able to be subclassed. Currently, nothing that is passed can ever be a LavalinkEventHandler.
Add guild_id parameter to Lavalink.play
Add guild_id parameter to Lavalink.play pyo3 text_signature in lib.rs
Make Lavalink.play synchronous in .pyi as it does not return a future. There is something off about this function, in my testing it did not behave normally unless I awaited it, as the examples in the docs show. However the rust code doesn't return a future and the type checker doesn't like that. With this change you can await the function and it behaves normally, but it may be worth looking into a better solution.

Related to #12 .