Skip to main content

paginator.py

Simple to use discord paginator for messages and embeds with reactions and buttons.


Features

  • Very easy to use
  • Customisable
  • Change pages with buttons or reactions
  • Actively maintained

Installation

You can easily install it using the python package manager pip

pip install paginator.py

Quickstart

Here are some examples that might help.

Sending a message with pages that uses reaction

from paginator import Paginator, Page, NavigationType
from discord import Embed

...

paginator = Paginator(bot)


@bot.command()
async def test(ctx):
    pages = [
        Page(content="React!", embed=Embed(title="Page #1", description="Testing")),
        Page(embed=Embed(title="Page #2", description="Still testing")),
        Page(embed=Embed(title="Page #3", description="Guess... testing"))
    ]

    await paginator.send(ctx.channel, pages, type=NavigationType.Reactions)

Sending a message with pages that uses buttons

from paginator import Paginator, Page, NavigationType
from discord import Embed

...

paginator = Paginator(bot)


@bot.command()
async def test(ctx):
    pages = [
        Page(content="Click!", embed=Embed(title="Page #1", description="Testing")),
        Page(embed=Embed(title="Page #2", description="Still testing")),
        Page(embed=Embed(title="Page #3", description="Guess... testing"))
    ]

    await paginator.send(ctx.channel, pages, type=NavigationType.Buttons)

Changing the emojis

from paginator import Paginator, PageEmojis

...

paginator = Paginator(bot)

class Emojis(PageEmojis):
    def __init__(self):
        super().__init__()

        self.back = "⏪"
        self.forward = "⏩"

paginator.page_emojis = Emojis()

Contributions

Feel free to open pull requests and improve the library. If you find any issues, please report it.

Metadata

Release files for paginator.py 0.9.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for paginator.py 0.9.4
File Size Uploaded Provenance Actions
paginator.py-0.9.4.tar.gz 5.0 kB Without provenance Details for paginator.py-0.9.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for paginator.py 0.9.4
File Interpreter ABI Platform Actions
paginator.py-0.9.4-py3-none-any.whl Python 3 none any Details for paginator.py-0.9.4-py3-none-any.whl

Total release size: 10.7 kB

Release files / paginator.py-0.9.4.tar.gz

Download URL paginator.py-0.9.4.tar.gz
Size 5.0 kB
Tags Source
SHA-256 checksum
How to use checksums
50f21400e8a308e5c06a3bcb5aea92ebb57855d6ba48d8488889ef00e91ee129
BLAKE2b-256 checksum
How to use checksums
9311fed24f902fb3207553184d0d0f7b856660de6091b0a84543aa65e7f00501
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.12

Release files / paginator.py-0.9.4-py3-none-any.whl

Download URL paginator.py-0.9.4-py3-none-any.whl
Size 5.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b908d8ff8007c7db03453aa2e16adfc014c8aa2a0b7538e4916ca79da40dc859
BLAKE2b-256 checksum
How to use checksums
9f5aba65b35faf6b355f3ea5811793f7bfcb29d2d45f9c93a39dbd87179ffc61
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.12

Security for paginator.py 0.9.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page