README.md
# SmallD-Click
[](https://badge.fury.io/py/smalld-click)
[](https://codeclimate.com/github/aymanizz/smalld-click/maintainability)
[](https://codeclimate.com/github/aymanizz/smalld-click/test_coverage)
[](https://conventionalcommits.org)
[](https://discord.gg/3aTVQtz)
SmallD-Click is an extension for [SmallD](https://github.com/princesslana/smalld.py) that enables the use of
[Click](https://click.palletsprojects.com/) CLI applications as discord bots.
## Installing
Install using pip:
```console
$ pip install smalld-click
```
## Example
```python
import click
from smalld import SmallD
from smalld_click import SmallDCliRunner
@click.command()
@click.option("--count", default=1, help="Number of greetings.")
@click.option("--name", prompt="Your name", help="The person to greet.")
def hello(count, name):
"""Simple program that greets NAME for a total of COUNT times."""
for x in range(count):
click.echo("Hello %s!" % name)
smalld = SmallD()
with SmallDCliRunner(smalld, hello, prefix="++"):
smalld.run()
```
For this CLI example, if a user sends the message "++hello --count=2", then the bot will ask the user -
by sending a message in the same channel - for their name, "Your name:".
If the user answers with "lymni", for example, the bot will send the message, "Hello lymni", twice.
Notice that the bot responds in a single message, instead of two, even though we call `click.echo` multiple times.
This is because calls to echo are buffered. However, calls to prompt will cause this buffer to be flushed and its
content is sent immediately.
There is also a timeout for how long the bot will wait for the user's message, if the timeout is exceeded the bot will
simply drop the execution of the command.
For an example with multiple commands that run under different names (i.e, with no common base command name)
see the [multicommands bot](examples/multicommands.py).
## Guide
```python
SmallDCliRunner(smalld, cli, prefix="", name=None, timeout=60, create_message=None, executor=None)
```
The `SmallDCliRunner` is the core class for running CLI applications.
- `smalld` the `SmallD` instance for your bot.
- `cli` a `click.Command` instance to use for running the commands.
- `prefix` each command invocation must start with this string.
- `name` the name of the CLI application, defaults to `cli.name`. Can be used to change the command's name,
or completely remove it by passing the empty string. Used with the prefix to determine what messages
to consider as invocations of the CLI application.
- `timeout` how long will the bot wait for the user to respond to a prompt in seconds.
- `create_message` a callback for creating the message payload for discord's create message route.
By default, text is sent as is in the content field of the payload.
- `executor` an instance of `concurrent.futures.Executor` used to execute commands. By default,
this is a `concurrent.futures.ThreadPoolExecutor`.
Instances of this class should be used as a context manager, to patch click functions and to properly close
the executor when the bot stops.
```python
Conversation(runner, message)
```
Represents the the state of the command invocation. Holds the runner instance, and the message payload.
Also manages the interactions between the user and the CLI application.
After each prompt, the message is updated to the latest message sent by the user.
```python
get_conversation()
```
Returns the current conversation. Must only be invoked inside of a command handler.
### Patched functionality
You can use `click.echo`, and `click.prompt` directly to send/wait for messages.
prompts that are hidden, using `hide_input=True`, are sent to the user DM, and cause the conversation to continue there.
Note that, echo and prompt will send a message in the same channel as the message that triggered the command invocation.
Calls to echo are buffered. When the buffer is flushed, its content is sent in 2K chunks (limit set by discord.)
The buffer can be flushed automatically when there is a prompt, or the command finishes execution, or the content
in the buffer exceeds the 2K limit.
It's also possible to flush the buffer by passing `flush=True` to `click.echo` call.
## Acknowledgements
Original idea by [Princess Lana](https://github.com/ianagbip1oti).
## Contributing
* [Tox](https://tox.readthedocs.io/) is used for running tests.
* Run `tox -e` to run tests with your installed python version
* Run `tox -e fmt` to format the code
* [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) is used for commit messages and pull requests
### Developing
Tox is used to setup and manage virtual environments when working on SmallD-Click
To run tests:
```console
$ tox
```
To run the examples greet bot:
```console
$ tox -e run -- examples/greet.py
```