Metadata-Version: 2.1
Name: alt-discord-flags
Version: 0.0.1
Summary: A Discord.py extension allowing you to pass flags as arguments.
Home-page: https://github.com/CircuitsBots/Flag-Parsing
Author: Circuit
License: MIT
Description: [download]: https://pypi.org/project/discord-flags/
        [version]: https://img.shields.io/pypi/v/Discord-Flags
        [license]: https://github.com/XuaTheGrate/Flag-Parsing/blob/master/LICENSE.md
        [license-s]: https://img.shields.io/github/license/XuaTheGrate/Flag-Parsing
        [python]: https://www.python.org/
        [python-s]: https://img.shields.io/pypi/pyversions/discord-flags
        
        [ ![version][] ][download]
        [ ![python-s][] ][python]
        [ ![license-s][] ][license]
        
        ⚠ Please be sure to read the entire README, it explains
        some important tricks.
        
        # Flag Parsing
        A util for discord.py bots that allow passing flags into commands.
        
        To install, run the following command:
        ```
        pip install discord-flags
        ```
        
        You can install the legacy parser by running:
        ```
        pip install discord-flags==1.5.2
        ```
        
        **2.1.0 changes how signatures appear. If you wish to use
        the legacy signatures, use `command.old_signature` instead.**
        
        Basic example usage:
        
        ```python
        import discord
        from discord.ext import flags, commands
        
        bot = commands.Bot("!")
        
        # Invocation: !flags --count=5 --string "hello world" --user Xua --thing y
        
        @flags.add_flag("--count", type=int, default=10)
        @flags.add_flag("--string", default="hello!")
        @flags.add_flag("--user", type=discord.User)
        @flags.add_flag("--thing", type=bool)
        @flags.command()
        async def flags(ctx, **flags):
            await ctx.send("--count={count!r}, --string={string!r}, --user={user!r}, --thing={thing!r}".format(**flags))
        bot.add_command(flags)
        ```
        
        Important note that `@flags.command` MUST be under all `@flags.add_flag`
        decorators.
        
        `@flags.add_flag` takes the same arguments as `argparse.ArgumentParser.add_argument`
        to keep things simple.
        
        Subcommands are just as simple:
        ```python
        @commands.group()
        async def my_group(ctx):
            ...
        
        @flags.add_flag("-n")
        @my_group.command(cls=flags.FlagCommand)
        async def my_subcommand(ctx, **flags):
            ...
        ```
        
        Usage of discord.py's `consume rest` behaviour is not perfect with `discord-flags`,
        meaning that you have to use a flag workaround:
        ```python
        @flags.add_flag("message", nargs="+")
        @flags.command()
        async def my_command(ctx, arg1, **options):
            """ You can now access `message` via `options['message']` """
            message = ' '.join(options['message'])
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
