Metadata-Version: 2.4
Name: sopel-bucket
Version: 2.0.1
Summary: A working re-implementation of the xkcd bucket bot for Sopel
Author-email: Rusty Bower <rusty@rustybower.com>
License: MIT
Project-URL: Homepage, https://github.com/sopel-irc/sopel-bucket
Project-URL: Bug Tracker, https://github.com/sopel-irc/sopel-bucket/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sopel>=8.0
Requires-Dist: pymysql
Dynamic: license-file

[![Python Tests](https://github.com/sopel-irc/sopel-bucket/actions/workflows/python-tests.yml/badge.svg?branch=master)](https://github.com/sopel-irc/sopel-bucket/actions/workflows/python-tests.yml)
[![PyPI version](https://badge.fury.io/py/sopel-bucket.svg)](https://badge.fury.io/py/sopel-bucket)

**Maintainer:** [@RustyBower](https://github.com/rustybower)

# sopel-bucket

A working re-implementation of the xkcd bucket bot for Sopel.

> **Note:** This package was previously published as `sopel-modules.bucket`.
> Please update your dependencies to use `sopel-bucket` instead.

# Requirements

apt-get install libmysqlclient-dev

# Usage
## Quotes
```
<User> Bot: random quote
<Bot> <User> Funny Quote
```

```
<User> Bot: random user
<Bot> <User> Another Funny Quote
```

```
<User> Bot: remember user2 word
<Bot> User: Remembered <User2> A Third Funny Quote
```

## Inventory
```
<User> Bot: you need new things
Bot drops all his inventory and picks up random things instead
```

```
<User> Bot: have an item
Bot takes an item but drops another item
```

```
<User> Bot: inventory
Bot is carrying an item, another item, a third item
```
