Metadata-Version: 2.1
Name: discord.py-pagination
Version: 0.0.3
Summary: Easily create pagination for your embeds.
Home-page: https://github.com/soosBot-com/Pagination
Author: soosBot
Author-email: support@soosbot.com
License: UNKNOWN
Description: # 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.
        
        ```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
        
        await Paginator.Simple(
            PreviousButton=PreviousButton,
            NextButton=NextButton,
            PageCounterStyle=PageCounterStyle,
            InitialPage=InitialPage,
            timeout=timeout).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/)
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Description-Content-Type: text/markdown
