Metadata-Version: 2.1
Name: discake
Version: 0.0.4
Summary: A discord py support library containing utilities.
Home-page: https://github.com/lollipop-69/discake
Author: Carlos
License: MIT
Project-URL: Homepage, https://github.com/lollipop-69/discake/
Keywords: discord py,discord paginator,paginator,button paginator
Classifier: Development Status :: 5 - Production/Stable
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: Programming Language :: Python :: 3.10
Requires-Python: >=3.8.0
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: discord.py

discake
==========

.. image:: https://discord.com/api/guilds/815886477066108968/embed.png
   :target: https://discord.gg/egvmz5NjSZ
   :alt: Discord server invite
.. image:: https://img.shields.io/pypi/v/discord.py.svg
   :target: https://pypi.python.org/pypi/discord.py
   :alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/discord.py.svg
   :target: https://pypi.python.org/pypi/discord.py
   :alt: PyPI supported Python versions

A discord py util library.

Key Features
-------------

- Button Paginator

Installing
----------

**Python 3.8 or higher is required**


.. code:: sh

    # Linux/macOS
    python3 -m pip install -U discake

    # Windows
    py -3 -m pip install -U discake


Quick Example
--------------

.. code:: py

    import discord
    from discord import Embed, Intents
    from discord.ext import commands
    from discake import Paginator

    class MyBot(comamnds.Bot):
        def __init__(self):
            super().__init__(command_prefix = '!')
            
        async def on_ready(self):
            print('Logged on as', self.user)

    client = MyBot(intents=Intents.default())
    
    @client.command(name = 'paginate', description = 'Pagination using the library')
    async def _paginate(ctx):
        entry_list = []
        for i in range(0,20):
            embed = Embed(description = f'This is the {i}th page')
            entry_list.append(embed)
        paginate_object = Paginator(
                entries = entry_list,
                timeout = 10.0
        )
        await paginate_object.send(ctx)
    
    
    client.run('TOKEN')

Links
------

- `Official Discord Server <https://discord.gg/egvmz5NjSZ>`_
