Metadata-Version: 2.1
Name: disputils
Version: 0.2.0
Summary: Some utilities for discord.py. Making Discord bot development easier.
Home-page: https://github.com/LiBa001/disputils
Author: Linus Bartsch
Author-email: linus.pypi@mabasoft.de
License: MIT
Description: .. image:: https://badge.fury.io/py/disputils.svg
            :target: https://pypi.org/project/disputils
            :alt: PyPI
        
        .. image:: https://img.shields.io/github/license/LiBa001/disputils
            :target: https://github.com/LiBa001/disputils/blob/master/LICENSE
            :alt: License
        
        .. image:: https://readthedocs.org/projects/disputils/badge/?version=latest
            :target: https://disputils.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation
        
        .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
            :target: https://github.com/psf/black
        
        *********
        Disputils
        *********
        
        Disputils provides some neat features to make your life as a bot developer easier.
        
        
        Install
        #######
        
        Install latest release from PyPI_ via pip:
        
        .. code-block:: bash
        
            python3.6 -m pip install disputils
        
        Or the freshest bleeding-edge code directly from GitHub_ using pip and git:
        
        .. code-block:: bash
        
            python3.6 -m pip install -U git+https://github.com/LiBa001/disputils
        
        
        .. note::
        
            A compatible version of `discord.py` will be installed automatically when
            downloading with pip. However, you should still require `discord.py` in
            your own setup.py or requirements.txt file.
        
        
        Features
        ########
        
        Quick overview of the available features.
        
        For all features there are two ways to use them.
        
        * just discord.py and a basic ``discord.Client``
        * discord.py commands extension (``discord.ext.commands``) and a ``Bot``
        
        In the following examples we're going to use the second way since it's a bit easier.
        
        .. code-block:: py
        
            from disputils import BotEmbedPaginator, BotConfirmation, BotMultipleChoice
        
        
        Pagination
        **********
        
        Split your content into multiple pages and use reactions to paginate through.
        
        .. code-block:: py
        
            @bot.command()
            async def paginate(ctx):
                embeds = [
                    Embed(title="test page 1", description="This is just some test content!", color=0x115599),
                    Embed(title="test page 2", description="Nothing interesting here.", color=0x5599ff),
                    Embed(title="test page 3", description="Why are you still here?", color=0x191638)
                ]
        
                paginator = BotEmbedPaginator(ctx, embeds)
                await paginator.run()
        
        .. image:: https://raw.githubusercontent.com/LiBa001/disputils/master/docs/img/paginate.png
        
        
        Multiple Choice
        ***************
        
        Let the user decide. Provide multiple choice!
        
        .. code-block:: py
        
            @bot.command()
            async def choice(ctx):
                multiple_choice = BotMultipleChoice(ctx, ['one', 'two', 'three', 'four', 'five', 'six'], "Testing stuff")
                await multiple_choice.run()
        
                await multiple_choice.quit(multiple_choice.choice)
        
        .. image:: https://raw.githubusercontent.com/LiBa001/disputils/master/docs/img/choice.png
        
        
        Confirmation
        ************
        
        Is the user going to do something irreversible? Let him confirm first!
        
        .. code-block:: py
        
            @bot.command()
            async def confirm(ctx):
                confirmation = BotConfirmation(ctx, 0x012345)
                await confirmation.confirm("Are you sure?")
        
                if confirmation.confirmed:
                    await confirmation.update("Confirmed", color=0x55ff55)
                else:
                    await confirmation.update("Not confirmed", hide_author=True, color=0xff5555)
        
        .. image:: https://raw.githubusercontent.com/LiBa001/disputils/master/docs/img/confirm.png
        
        
        Requirements
        ############
        
        * Python >= 3.6
        * `discord.py >= v1.0.0 (rewrite)`_
        
        
        .. _discord.py >= v1.0.0 (rewrite): https://discordpy.readthedocs.io/en/latest/migrating.html
        .. _PyPI: https://pypi.org/project/disputils/
        .. _GitHub: https://github.com/LiBa001/disputils
        
Keywords: discord discord-py discord-bot utils utility
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
