Metadata-Version: 1.1
Name: wavelink
Version: 1.0.0b21
Summary: A robust and powerful Lavalink wrapper for discord.py.
Home-page: https://github.com/PythonistaGuild/Wavelink
Author: PythonistaGuild, EvieePy
Author-email: UNKNOWN
License: MIT
Description: .. image:: logo.png?raw=true
            :align: center
        
        .. image:: https://img.shields.io/badge/Python-3.7%20%7C%203.8%20%7C%203.9-blue.svg
            :target: https://www.python.org
            :align: center
            
        .. image:: https://img.shields.io/github/license/EvieePy/Wavelink.svg
            :target: LICENSE
            :align: center
        
        Wavelink is robust and powerful Lavalink wrapper for `Discord.py <https://github.com/Rapptz/discord.py>`_!
        Wavelink features a fully asynchronous API that's intuitive and easy to use.
        
        Documentation
        ---------------------------
        `Official Documentation <https://wavelink.readthedocs.io/en/1.0/wavelink.html>`_.
        
        Support
        ---------------------------
        For support using WaveLink, please join the official `support server
        <https://discord.gg/RAKc3HF>`_ on `Discord <https://discordapp.com/>`_.
        
        |Discord|
        
        .. |Discord| image:: https://img.shields.io/discord/490948346773635102?color=%237289DA&label=Pythonista&logo=discord&logoColor=white
           :target: https://discord.gg/RAKc3HF
        
        Installation
        ---------------------------
        The following commands are currently the valid ways of installing WaveLink.
        
        **WaveLink requires Python 3.8+**
        
        **Windows**
        
        .. code:: sh
        
            py -3.9 -m pip install Wavelink --pre
        
        **Linux**
        
        .. code:: sh
        
            python3.9 -m pip install Wavelink --pre
        
        Getting Started
        ----------------------------
        
        A quick and easy bot example:
        
        .. code:: py
            
            import wavelink
            from discord.ext import commands
        
        
            class Bot(commands.Bot):
        
                def __init__(self):
                    super().__init__(command_prefix='>?')
        
                async def on_ready(self):
                    print('Bot is ready!')
        
        
            class Music(commands.Cog):
                """Music cog to hold Wavelink related commands and listeners."""
        
                def __init__(self, bot: commands.Bot):
                    self.bot = bot
        
                    bot.loop.create_task(self.connect_nodes())
        
                async def connect_nodes(self):
                    """Connect to our Lavalink nodes."""
                    await self.bot.wait_until_ready()
        
                    await wavelink.NodePool.create_node(bot=bot,
                                                        host='0.0.0.0',
                                                        port=2333,
                                                        password='YOUR_LAVALINK_PASSWORD')
        
                @commands.Cog.listener()
                async def on_wavelink_node_ready(self, node: wavelink.Node):
                    """Event fired when a node has finished connecting."""
                    print(f'Node: <{node.identifier}> is ready!')
        
                @commands.command()
                async def play(self, ctx: commands.Context, *, search: wavelink.YouTubeTrack):
                    """Play a song with the given search query.
        
                    If not connected, connect to our voice channel.
                    """
                    if not ctx.voice_client:
                        vc: wavelink.Player = await ctx.author.voice.channel.connect(cls=wavelink.Player)
                    else:
                        vc: wavelink.Player = ctx.voice_client
        
                    await vc.play(search)
        
        
            bot = Bot()
            bot.add_cog(Music(bot))
            bot.run('YOUR_BOT_TOKEN')
        
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.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
