https://github.com/Soheab/discord-py-paginators

https://discord-py-paginators.readthedocs.io/en/latest/
https://github.com/Soheab/discord-py-paginators

Last synced: 3 months ago
JSON representation

https://discord-py-paginators.readthedocs.io/en/latest/

• Host: GitHub
• URL: https://github.com/Soheab/discord-py-paginators
• Owner: Soheab
• License: mpl-2.0
• Created: 2023-09-15T09:31:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-22T13:38:09.000Z (4 months ago)
• Last Synced: 2024-10-06T19:35:56.184Z (3 months ago)
• Language: Python
• Size: 182 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-discordpy - Soheab/discord-py-paginators - An extension for discord.py that provides various paginators. (Libraries and Extensions / UI - Pagination, Menus, Embeds and similar)

README

        
.. discord-py-paginators documentation master file, created by

   sphinx-quickstart on Tue Dec 26 17:07:44 2023.

   You can adapt this file completely to your liking, but it should at least

   contain the root `toctree` directive.

Welcome to discord-py-paginators's documentation!

=================================================

Extension for discord.py that provides various paginators.

Installation

============= 

Stable

-------

.. code-block:: bash

   python -m pip install discord-py-paginators

Dev

----

.. note::

   This requires `git `_ to be installed on your system.

.. code-block:: bash	

   

      python -m pip install -U "discord-py-paginators @ git+https://github.com/Soheab/discord-py-paginators"

Usage

======

.. code-block:: python

   import discord

   from discord.ext import commands

   from discord.ext.paginators.button_paginator import ButtonPaginator

   bot = commands.Bot(command_prefix=commands.when_mentioned, intents=discord.Intents(guilds=True, messages=True))

   @bot.command()

   async def paginate(ctx):

       list_with_many_items = list(range(100))

       paginator = ButtonPaginator(list_with_many_items, author_id=ctx.author.id)

       await paginator.send(ctx)

       # Enjoy!

   bot.run("token")

Examples

=========

Examples can be found in the `examples directory `_.

Links

======

- `Documentation `_

- `Source code `_

- `Discord server `_

Contact

========

Send a DM on discord at `Soheab_`, join the ``discord server`` or ping me in the `discord.py server `_.