Skip to main content

A simple to use, interactive session and paginator with custom buttons for discord.py.

Project description

A simple to use, highly customizable, Interactive Session and Paginator for discord.py.
Still in alpha stages, and rapid production. Feel free to suggest something via Discord.

Support
---------------------------
For support using Buttons, please join the official `support server
<http://discord.gg/JhW28zp>`_ on `Discord <https://discordapp.com/>`_.

Installation
---------------------------
**Buttons requires Python 3.6 or higher.**

**Windows**

.. code:: sh

py -version -m pip install buttons

**Linux**

.. code:: sh

python3 -m pip install buttons

Getting Started
----------------------------
A quick and easy paginator example:

.. code:: py
from discord.ext import commands
from discord.ext import buttons


class MyPaginator(buttons.Paginator):

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)

@buttons.button(emoji='\u23FA')
async def record_button(self, ctx):
await ctx.send('This button sends a silly message! But could be programmed to do much more.')

@buttons.button(emoji='my_custom_emoji:1234567890')
async def silly_button(self, ctx):
await ctx.send('Beep boop...')


bot = commands.Bot(command_prefix='??')


@bot.command()
async def test(ctx):
pagey = MyPaginator(title='Silly Paginator', colour=0xc67862, embed=True, timeout=90, use_defaults=True,
entries=[1, 2, 3], length=1, format='**')

await pagey.start(ctx)


@bot.event
async def on_ready():
print('Ready!')


bot.run('TOKEN')


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

buttons-0.0.5.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

buttons-0.0.5-py3-none-any.whl (5.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page