<div>
<h1 align='center'>
paginator.py
</h1>
</div>
<div>
<p align='center'>
<img src=https://img.shields.io/pypi/dm/paginator.py?color=success&label=PyPi%20Downloads&style=flat-square>
<img src=https://shields.io/github/issues-raw/FlamptX/discord-paginator?color=success&label=Active%20Issues&style=flat-square>
<img src=https://img.shields.io/badge/Latest_Version-0.9.4-informational>
</p>
<p align='center'>
Simple to use discord paginator for messages and embeds with reactions and buttons.
</p>
</div>
<br>
## Features
- Very easy to use
- Customisable
- Change pages with buttons or reactions
- Actively maintained
## Links
- **[Documentation](https://flampt.gitbook.io/paginator)**
- **[PyPi](https://pypi.org/project/paginator.py)**
## 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
```python
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
```python
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
```python
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/FlamptX/paginator.py",
"name": "paginator.py",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "discord paginator discord-paginator",
"author": "Flampt",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/93/11/fed24f902fb3207553184d0d0f7b856660de6091b0a84543aa65e7f00501/paginator.py-0.9.4.tar.gz",
"platform": null,
"description": "<div>\r\n <h1 align='center'>\r\n paginator.py\r\n </h1>\r\n</div>\r\n<div>\r\n <p align='center'>\r\n <img src=https://img.shields.io/pypi/dm/paginator.py?color=success&label=PyPi%20Downloads&style=flat-square>\r\n <img src=https://shields.io/github/issues-raw/FlamptX/discord-paginator?color=success&label=Active%20Issues&style=flat-square>\r\n <img src=https://img.shields.io/badge/Latest_Version-0.9.4-informational>\r\n </p>\r\n <p align='center'>\r\n Simple to use discord paginator for messages and embeds with reactions and buttons.\r\n </p>\r\n</div>\r\n<br>\r\n\r\n## Features\r\n- Very easy to use\r\n- Customisable\r\n- Change pages with buttons or reactions\r\n- Actively maintained\r\n## Links\r\n- **[Documentation](https://flampt.gitbook.io/paginator)**\r\n- **[PyPi](https://pypi.org/project/paginator.py)**\r\n## Installation\r\nYou can easily install it using the python package manager `pip`\r\n\r\n```\r\npip install paginator.py\r\n```\r\n\r\n## Quickstart\r\nHere are some examples that might help.\r\n### Sending a message with pages that uses reaction\r\n\r\n```python\r\nfrom paginator import Paginator, Page, NavigationType\r\nfrom discord import Embed\r\n\r\n...\r\n\r\npaginator = Paginator(bot)\r\n\r\n\r\n@bot.command()\r\nasync def test(ctx):\r\n pages = [\r\n Page(content=\"React!\", embed=Embed(title=\"Page #1\", description=\"Testing\")),\r\n Page(embed=Embed(title=\"Page #2\", description=\"Still testing\")),\r\n Page(embed=Embed(title=\"Page #3\", description=\"Guess... testing\"))\r\n ]\r\n\r\n await paginator.send(ctx.channel, pages, type=NavigationType.Reactions)\r\n```\r\n### Sending a message with pages that uses buttons\r\n\r\n```python\r\nfrom paginator import Paginator, Page, NavigationType\r\nfrom discord import Embed\r\n\r\n...\r\n\r\npaginator = Paginator(bot)\r\n\r\n\r\n@bot.command()\r\nasync def test(ctx):\r\n pages = [\r\n Page(content=\"Click!\", embed=Embed(title=\"Page #1\", description=\"Testing\")),\r\n Page(embed=Embed(title=\"Page #2\", description=\"Still testing\")),\r\n Page(embed=Embed(title=\"Page #3\", description=\"Guess... testing\"))\r\n ]\r\n\r\n await paginator.send(ctx.channel, pages, type=NavigationType.Buttons)\r\n```\r\n## Changing the emojis\r\n\r\n```python\r\nfrom paginator import Paginator, PageEmojis\r\n\r\n...\r\n\r\npaginator = Paginator(bot)\r\n\r\nclass Emojis(PageEmojis):\r\n def __init__(self):\r\n super().__init__()\r\n\r\n self.back = \"\u23ea\"\r\n self.forward = \"\u23e9\"\r\n\r\npaginator.page_emojis = Emojis()\r\n```\r\n## Contributions\r\nFeel free to open pull requests and improve the library. If you find any issues, please report it.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple to use discord paginator for messages and embeds with reactions and buttons.",
"version": "0.9.4",
"split_keywords": [
"discord",
"paginator",
"discord-paginator"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "d98601091f35b9f534a7e4b64f4affb4",
"sha256": "b908d8ff8007c7db03453aa2e16adfc014c8aa2a0b7538e4916ca79da40dc859"
},
"downloads": -1,
"filename": "paginator.py-0.9.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d98601091f35b9f534a7e4b64f4affb4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5710,
"upload_time": "2022-12-07T15:20:39",
"upload_time_iso_8601": "2022-12-07T15:20:39.708887Z",
"url": "https://files.pythonhosted.org/packages/9f/5a/ba65b35faf6b355f3ea5811793f7bfcb29d2d45f9c93a39dbd87179ffc61/paginator.py-0.9.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "8b3a452addfb1615fe9ab3989f894a8e",
"sha256": "50f21400e8a308e5c06a3bcb5aea92ebb57855d6ba48d8488889ef00e91ee129"
},
"downloads": -1,
"filename": "paginator.py-0.9.4.tar.gz",
"has_sig": false,
"md5_digest": "8b3a452addfb1615fe9ab3989f894a8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5026,
"upload_time": "2022-12-07T15:20:42",
"upload_time_iso_8601": "2022-12-07T15:20:42.965640Z",
"url": "https://files.pythonhosted.org/packages/93/11/fed24f902fb3207553184d0d0f7b856660de6091b0a84543aa65e7f00501/paginator.py-0.9.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-07 15:20:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "FlamptX",
"github_project": "paginator.py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "paginator.py"
}
JSON
