Metadata-Version: 2.4
Name: sopel-jisho
Version: 1.0.0
Summary: Jisho lookup plugin for Sopel IRC bots.
Author-email: dgw <dgw@technobabbl.es>
License-Expression: GPL-3.0-only
Project-URL: Homepage, https://github.com/dgw/sopel-jisho
Project-URL: Bug Tracker, https://github.com/dgw/sopel-jisho/issues
Keywords: sopel,plugin,bot,irc
Platform: Linux x86, x86-64
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Requires-Python: <4,>=3.8
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: sopel>=8.0
Requires-Dist: requests
Dynamic: license-file

# sopel-jisho

Sopel plugin to search Jisho.org, a Japanese/English dictionary.

## Installing

Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:

```shell
$ pip install sopel-jisho
```

### Requirements

`sopel-jisho` requires Sopel 7.1+ and `requests`.

## Usage
Commands & arguments:

* `.jisho <search query>` (also available as `.ji`)
  * `<search query>`: the keyword(s) to search for on Jisho

## Notes

The plugin is more or less stable. In testing, this version has not yet failed
to output definitions when available.

However, Jisho's API is undocumented and subject to change, so there are sure to
be edge cases where the code receives something it doesn't expect. Some of these
are handled. Others aren't…yet. Check the [issue tracker][] if you run into
anything that doesn't seem to work correctly, and create a report if needed.

[issue tracker]: https://github.com/dgw/sopel-jisho/issues

## Changelog

### 1.0.0

Overhauled with better output:

- Output as many senses as will fit in an IRC line, not just the first one
- Senses are numbered and labeled with part-of-speech if available
- Always end with a link to the Jisho page for that word


### 0.1.0

First packaged release of `sopel-jisho`.
