Metadata-Version: 2.4
Name: sopel-xkcd
Version: 1.0.0
Summary: xkcd plugin for Sopel IRC bots.
Author-email: dgw <dgw@technobabbl.es>
License-Expression: EFL-2.0
Project-URL: Homepage, https://github.com/sopel-irc/sopel-xkcd
Project-URL: Bug Tracker, https://github.com/sopel-irc/sopel-xkcd/issues
Keywords: sopel,plugin,xkcd,bot,irc
Platform: Linux x86, x86-64
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Requires-Python: <4,>=3.8
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: sopel<9,>=8
Requires-Dist: requests
Dynamic: license-file

# sopel-xkcd

xkcd plugin for Sopel IRC bots.

## Features & Usage

This plugin provides lookup commands and automatic URL expansion for
[xkcd](https://xkcd.com/) comics in Sopel IRC bots.

- `.xkcd` — Get a random comic
- `.xkcd <number>` — Get a specific comic by number (e.g., `.xkcd 303`)
- `.xkcd 0` — Get the most recent comic
- `.xkcd -<n>` — Get the nth-latest comic (e.g., `.xkcd -1` for the previous comic)
- `.xkcd <keywords>` — Search for a comic by keywords (e.g., `.xkcd battery staple`)
- Posting an `xkcd.com` URL in chat will fetch the comic's title and alt-text

## Installation

After installing Sopel, install this plugin with `pip`:

```shell
pip install sopel-xkcd
```

## Configuration

No configuration is required.

## Credits

This is a continuation of Sopel 8.0's built-in `xkcd` plugin. You can find the
original file [in Sopel's history][upstream-src].

[//]: # (upstream-src is also used in NEWS entry for 1.0.0)
[upstream-src]: https://github.com/sopel-irc/sopel/blob/c1541f419035c8d18aa66bf60fae9f096b4b362d/sopel/builtins/xkcd.py

## Changelog

### 1.0.0

Initial release. Straight copy of [Sopel 8.0's version][upstream-src]
(with minor tweaks to make it behave correctly outside of
`sopel.builtins`).

[//]: # (upstream-src is defined in README.md)
