# discord.py-pagination
#### discord.py-pagination is a Python library to easily create embed paginators.
<img src="https://cdn.soosbot.com/images/pagination-requirement.svg" alt="WARNING IMAGE NOT FOUND">
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install the library.
```bash
pip install discord.py-pagination
```
## Usage
### Quickstart
```python
import Paginator
# Create a list of embeds to paginate.
embeds = [discord.Embed(title="First embed"),
discord.Embed(title="Second embed"),
discord.Embed(title="Third embed")]
... # Inside a command.
await Paginator.Simple().start(ctx, pages=embeds)
```
### Advanced
##### To use custom buttons, pass in the corresponding argument when you initiate the paginator. **THESE ARE OPTIONAL**
```python
# These arguments override the default ones.
PreviousButton = discord.ui.Button(...)
NextButton = discord.ui.Button(...)
PageCounterStyle = discord.ButtonStyle(...) # Only accepts ButtonStyle instead of Button
InitialPage = 0 # Page to start the paginator on.
timeout = 42069 # Seconds to timeout. Default is 60
ephemeral = true # Defaults to false if not passed in.
await Paginator.Simple(
PreviousButton=PreviousButton,
NextButton=NextButton,
PageCounterStyle=PageCounterStyle,
InitialPage=InitialPage,
timeout=timeout, ephemeral=ephemeral).start(ctx, pages=embeds)
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/DencePixel/Paginator",
"name": "Markinator",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Mark",
"author_email": "mark@blerp.co.uk",
"download_url": "",
"platform": null,
"description": "# discord.py-pagination\r\n\r\n#### discord.py-pagination is a Python library to easily create embed paginators.\r\n\r\n<img src=\"https://cdn.soosbot.com/images/pagination-requirement.svg\" alt=\"WARNING IMAGE NOT FOUND\">\r\n\r\n## Installation\r\n\r\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install the library.\r\n\r\n```bash\r\npip install discord.py-pagination\r\n```\r\n\r\n## Usage\r\n\r\n### Quickstart\r\n```python\r\nimport Paginator\r\n\r\n# Create a list of embeds to paginate.\r\nembeds = [discord.Embed(title=\"First embed\"),\r\n discord.Embed(title=\"Second embed\"),\r\n discord.Embed(title=\"Third embed\")]\r\n\r\n... # Inside a command.\r\nawait Paginator.Simple().start(ctx, pages=embeds)\r\n```\r\n\r\n### Advanced\r\n\r\n##### To use custom buttons, pass in the corresponding argument when you initiate the paginator. **THESE ARE OPTIONAL**\r\n\r\n```python\r\n# These arguments override the default ones.\r\n\r\nPreviousButton = discord.ui.Button(...)\r\nNextButton = discord.ui.Button(...)\r\nPageCounterStyle = discord.ButtonStyle(...) # Only accepts ButtonStyle instead of Button\r\nInitialPage = 0 # Page to start the paginator on.\r\ntimeout = 42069 # Seconds to timeout. Default is 60\r\nephemeral = true # Defaults to false if not passed in.\r\n\r\nawait Paginator.Simple(\r\n PreviousButton=PreviousButton,\r\n NextButton=NextButton,\r\n PageCounterStyle=PageCounterStyle,\r\n InitialPage=InitialPage,\r\n timeout=timeout, ephemeral=ephemeral).start(ctx, pages=embeds)\r\n```\r\n## Contributing\r\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\r\n\r\nPlease make sure to update tests as appropriate.\r\n\r\n## License\r\n[MIT](https://choosealicense.com/licenses/mit/)\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Easily create pagination for your embeds.",
"version": "0.0.6",
"project_urls": {
"Homepage": "https://github.com/DencePixel/Paginator"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "532b696f64062bb38c529f3eee87d010df1152020ef8b9a8354e8a4adaeacd7c",
"md5": "5ae3bf317f69e1a618a3f5f661498192",
"sha256": "ec1ab4bd84c2f4bbbc4510cce298f14f0828fd39dc4854d42d9e8787b116b860"
},
"downloads": -1,
"filename": "Markinator-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5ae3bf317f69e1a618a3f5f661498192",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2885,
"upload_time": "2023-09-02T20:32:47",
"upload_time_iso_8601": "2023-09-02T20:32:47.539908Z",
"url": "https://files.pythonhosted.org/packages/53/2b/696f64062bb38c529f3eee87d010df1152020ef8b9a8354e8a4adaeacd7c/Markinator-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-02 20:32:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DencePixel",
"github_project": "Paginator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "markinator"
}
JSON
