Metadata-Version: 1.2
Name: nextlava
Version: 1.4.1b3
Summary: A powerful and robust Python library built from the ground up for interacting with Lavalink.
Home-page: https://github.com/Aspect1103/Lavapy
Author: Aspect1103 & rexwu1104
Author-email: jack.ashwell1@gmail.com
License: MIT
Description: .. image:: https://raw.githubusercontent.com/Aspect1103/Lavapy/master/logo.png
            :align: center
            :width: 1000px
        
        .. image:: https://img.shields.io/pypi/pyversions/Lavapy
            :target: https://pypi.org/project/Lavapy/
        
        .. image:: https://img.shields.io/pypi/v/Lavapy
            :target: https://pypi.org/project/Lavapy/
        
        .. image:: https://readthedocs.org/projects/lavapy/badge/?version=latest
            :target: https://lavapy.readthedocs.io/en/latest/?badge=latest
        
        .. image:: https://img.shields.io/github/license/Aspect1103/Lavapy
            :target: LICENSE
        
        .. image:: https://img.shields.io/lgtm/grade/python/g/Aspect1103/Lavapy.svg?logo=lgtm&logoWidth=18
            :target: https://lgtm.com/projects/g/Aspect1103/Lavapy/context:python
        
        A powerful and robust Python library built from the ground up for interacting with `Lavalink <https://github.com/freyacodes/Lavalink>`_.
        
        Installation
        ------------
        Lavapy requires Python 3.8 or higher
        
        To install Lavapy, use one of the commands below:
        
        .. code:: sh
        
            # Windows
            py -3.8 -m pip install -U nextlava
        
            # Linux/macOS
            python3.8 -m pip install -U nextlava
        
        Then you need to `setup <https://github.com/freyacodes/Lavalink#server-configuration>`_ the Lavalink server. For more details visit the faq.
        
        Now all of that is done, you can start using Lavapy (nextcord version).
        Don't need to uninstall discord.py.
        
        Usage
        -----
        A simple and easy example to connect to a voice channel and play a Youtube song based on a given search query.
        
        .. code:: py
        
            from nextcord.ext import commands
            import lavapy
        
            bot = commands.Bot(command_prefix="!")
        
        
            async def initialiseNodes():
                """
                Wait until the bot is ready then create a Lavapy node
                """
                await bot.wait_until_ready()
        
                await lavapy.NodePool.createNode(client=bot,
                                                 host="0.0.0.0",
                                                 port=2333,
                                                 password="LAVALINK_PASSWORD")
        
        
            @bot.command()
            async def play(ctx: commands.Context, *query) -> None:
                """
                Play a Youtube song from a given search query.
        
                If the bot is not connected, connect it to the user's voice channel. For this
                to work, the user must be connected to a voice channel
                """
                if not ctx.voice_client:
                    # Bot is not connected to a voice channel
                    try:
                        player: lavapy.Player = await ctx.author.voice.channel.connect(cls=lavapy.Player)
                    except AttributeError:
                        # User is not connected to a voice channel
                        await ctx.channel.send("You must be connected to a voice channel")
                        return
                else:
                    # Bot is connected to a voice channel
                    player: lavapy.Player = ctx.voice_client
        
                # Get tracks based on the given search query
                track = await lavapy.YoutubeTrack.search(" ".join(query), player.node)
                await player.play(track)
        
        
            bot.loop.create_task(initialiseNodes())
            bot.run("BOT_TOKEN")
        
        Links
        -----
        - `Official Documentation <https://lavapy.readthedocs.io/en/latest/>`_
        - `Source Code <https://github.com/Aspect1103/Lavapy>`_
        - `Issue Tracker <https://github.com/Aspect1103/Lavapy/issues>`_
        
Keywords: lavapy,lavalink,nextocrd
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.8
