-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Convert to a package using latest Sopel 8+ cookiecutter template
First time I've done this for a plugin not under EFLv2, which threw me for a bit of a loop. Finding the GPLv3 text to paste into COPYING (over top of the template's EFLv2 text) wasn't too hard, though. I *could* relicense the thing, since it's my own damn code, but I also happen to appreciate having some variety in my life.
- Loading branch information
Showing
8 changed files
with
764 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
include NEWS | ||
include COPYING | ||
include README.md | ||
|
||
recursive-exclude * __pycache__ | ||
recursive-exclude * *.py[co] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
## Changelog | ||
|
||
### 0.1.0 | ||
|
||
First packaged release of `sopel-jisho`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,35 @@ | ||
# sopel-jisho | ||
Sopel plugin that provides search results from the Jisho Japanese/English dictionary | ||
|
||
This plugin has alpha-level functionality. It can request and display most results, but | ||
may not correctly deal with incomplete API responses (words that have no readings, for | ||
example). That said, anything that doesn't behave as expected should be reported in the | ||
plugin's [issue tracker](https://github.com/dgw/sopel-jisho/issues) if it isn't already | ||
listed there (be sure to **also search closed issues!**). | ||
Sopel plugin to search Jisho.org, a Japanese/English dictionary. | ||
|
||
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. Report problematic queries to the issue tracker. | ||
## Installing | ||
|
||
## Requirements | ||
The Jisho plugin relies on `requests`, which Sopel itself also requires. | ||
Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`: | ||
|
||
You will need Sopel 7.1+ to load this plugin. | ||
```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 | ||
|
||
This plugin has beta-level functionality. It can search and display most | ||
queries, but may not correctly deal with incomplete API responses (for example, | ||
words that have no readings). That said, anything that doesn't behave as | ||
expected should be reported in the plugin's [issue tracker][] if it isn't | ||
already listed there (be sure to **also search closed issues!**). | ||
|
||
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. Report problematic queries to the issue tracker. | ||
|
||
[issue tracker]: https://github.com/dgw/sopel-jisho/issues |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
[build-system] | ||
requires = ["setuptools>=63.0", "wheel"] | ||
build-backend = "setuptools.build_meta" | ||
|
||
[tool.setuptools] | ||
platforms = ["Linux x86, x86-64"] | ||
|
||
[tool.setuptools.packages.find] | ||
include = ["sopel_jisho", "sopel_jisho.*"] | ||
namespaces = false | ||
|
||
[tool.setuptools.dynamic] | ||
readme = { file=["README.md", "NEWS"], content-type="text/markdown" } | ||
|
||
[project] | ||
name = "sopel-jisho" | ||
version = "0.1.0" | ||
description = "Jisho lookup plugin for Sopel IRC bots." | ||
|
||
authors = [ | ||
{ name="dgw", email="[email protected]" }, | ||
] | ||
|
||
license = { text="GPL-3.0" } | ||
dynamic = ["readme"] | ||
|
||
classifiers = [ | ||
"Development Status :: 4 - Beta", | ||
"Intended Audience :: Developers", | ||
"Intended Audience :: System Administrators", | ||
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", | ||
"Topic :: Communications :: Chat :: Internet Relay Chat", | ||
] | ||
keywords = [ | ||
"sopel", | ||
"plugin", | ||
"bot", | ||
"irc", | ||
] | ||
|
||
requires-python = ">=3.8, <4" | ||
dependencies = [ | ||
"sopel>=8.0", | ||
] | ||
|
||
[project.urls] | ||
"Homepage" = "https://github.com/dgw/sopel-jisho" | ||
"Bug Tracker" = "https://github.com/dgw/sopel-jisho/issues" | ||
|
||
[project.entry-points."sopel.plugins"] | ||
"jisho" = "sopel_jisho.plugin" |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters