revvlink 1.0.5

A robust and powerful, fully asynchronous Lavalink wrapper built for discord.py in Python.

RevvLink

The Definitive Lavalink Wrapper for Python

---

RevvLink is a next-generation, high-performance Lavalink wrapper built specifically for modern Discord bot development in Python. Engineered with versatility and scale in mind, RevvLink offers a professional-grade API that makes audio integration seamless and powerful. Inspired by Wavelink.

---

Table of Contents

• Table of Contents
• Why RevvLink?
• Features
• Architecture
• Installation
• Quickstart
• Examples
• Contributing
• License

---

Why RevvLink?

	Extreme Performance: Built on top of a fully asynchronous architecture, RevvLink handles heavy loads with minimal overhead.
	State-of-the-Art Logic: Features advanced regional load balancing, penalty-based node selection, and intelligent failover migration.
	Enterprise Queue System: Robust queue management with support for custom storage backends and deep manipulation APIs.
	Modern Standards: Fully compatible with Lavalink v4.0+, including native support for the DAVE E2EE protocol and specialized plugins like LavaSrc.
	Strictly Typed: Developed with Pyright strict compliance to ensure your code is bug-free and easy to maintain.
	AI-Ready Documentation: Integration with Context 7 ensures our documentation is perfectly readable for AI, allowing you to build and debug faster.

---

Features

---

Architecture & Flow

---

Installation

RevvLink requires Python 3.10+.

# Stable version from PyPI
pip install revvlink

For the latest development version:

pip install git+https://github.com/RevvLabs/RevvLink.git

---

Quickstart

Here is a minimal example of how to get up and running with RevvLink.

import discord
from discord.ext import commands
import revvlink

class Bot(commands.Bot):
    def __init__(self) -> None:
        super().__init__(command_prefix="!", intents=discord.Intents.all())

    async def setup_hook(self) -> None:
        # Connect to your Lavalink nodes
        nodes = [revvlink.Node(uri="http://localhost:2333", password="youshallnotpass")]
        await revvlink.Pool.connect(nodes=nodes, client=self)

bot = Bot()

@bot.command()
async def play(ctx: commands.Context, *, query: str) -> None:
    if not ctx.voice_client:
        vc: revvlink.Player = await ctx.author.voice.channel.connect(cls=revvlink.Player)
    else:
        vc: revvlink.Player = ctx.voice_client

    tracks = await revvlink.Playable.search(query)
    if not tracks:
        return await ctx.send("No tracks found.")

    track = tracks[0]
    await vc.play(track)
    await ctx.send(f"Now playing: {track.title}")

bot.run("YOUR_TOKEN")

---

Examples

Check the examples directory for advanced usage, including:

• Custom Queue Handlers
• Advanced Filters (Nightcore, etc.)
• Regional Load Balancing Configuration
• AutoPlay and Recommendation Systems

---

Development

To run the codebase locally and ensure everything is passing:

# Install development dependencies
pip install -e ".[dev]"

# Run Linting and Formatting checks
ruff check .
ruff format --check .

# Run Type Checking
pyright

# Run Tests
pytest

---

Contributing

We welcome contributions! If you'd like to help improve RevvLink:

1. Fork the repository to your own account.
2. Clone your fork and create a new feature branch (git checkout -b feature/amazing-feature).
3. Commit your improvements (git commit -m 'feat: add some amazing feature').
4. Push the changes to your fork (git push origin feature/amazing-feature).
5. Open a Pull Request from your fork to our main branch.

Please ensure your code follows our Ruff and Pyright configurations.

---

	Official Docs: revvlink.revvlabs.in
	Community: Discord Server

---

Credits

• Wavelink for the architectural inspiration.
• Lavalink for the amazing audio server.

---

License

RevvLink is released under the MIT License. See LICENSE for more information.