| Name | sopel-pronouns JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Pronoun-sharing plugin for Sopel IRC bots |
| upload_time | 2024-07-08 22:10:36 |
| maintainer | None |
| docs_url | None |
| author | Elsie Powell |
| requires_python | <4,>=3.8 |
| license | EFL-2.0 |
| keywords |
sopel
plugin
bot
irc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sopel-pronouns
Pronoun-sharing plugin for Sopel IRC bots
## Installing
Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:
```shell
$ pip install sopel-pronouns
```
## Configuring
The easiest way to configure `sopel-pronouns` is via Sopel's
configuration wizard—simply run `sopel-plugins configure pronouns`
and enter the values for which it prompts you.
Options are:
* `fetch_complete_list`: Whether to download the complete list of supported
pronoun sets at startup
* `fetch_url`: An optional custom fetch URL for the complete list (see below)
* `link_base_url`: An optional custom base URL for links in the plugin's output
The `link_base_url` option allows you to use your own domain to host your own
instance of [our pronoun service][pronoun-service] hosted at
[`pronouns.sopel.chat`][pronouns-instance], which is itself a fork of Lucas
Eduardo's [lovely little Svelte project][original-pronoun-service].
If you want to customize the available pronoun sets, set the `fetch_url` to your
own instance's `pronouns.tab` file or an equivalent tab-delimited data source.
[pronoun-service]: https://github.com/sopel-irc/pronoun-service
[pronouns-instance]: https://pronouns.sopel.chat/
[original-pronoun-service]: https://github.com/lucasew/svelte-pronounisland
## Credits
`sopel-pronouns` is based on the `pronouns.py` plugin that was built into Sopel
from version 6.5.1 through 8.0. Special thanks to Elsie Powell and other
contributors to the original code, whose work can be viewed in the main Sopel
repository's [commit history][original-history].
[original-history]: https://github.com/sopel-irc/sopel/commits/d4a0efde1a4bdea03be265d5e23591b553a0ce76/sopel/modules/pronouns.py
## Changelog
### 0.1.0
First release of `sopel-pronouns`.
New standalone plugin based on the `pronouns` builtin from Sopel 8.0.0.
**New feature:** Optionally fetch a custom `pronouns.tab` to match your own
[pronoun service](https://github.com/sopel-irc/pronoun-service) instance. See
README for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "sopel-pronouns",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": "dgw <dgw@technobabbl.es>",
"keywords": "sopel, plugin, bot, irc",
"author": "Elsie Powell",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/82/ef/967bc39eb887a83197aa64d63e46fdb83b0ec540aee80020403ee9692dc3/sopel_pronouns-0.1.0.tar.gz",
"platform": "Linux x86, x86-64",
"description": "# sopel-pronouns\n\nPronoun-sharing plugin for Sopel IRC bots\n\n## Installing\n\nReleases are hosted on PyPI, so after installing Sopel, all you need is `pip`:\n\n```shell\n$ pip install sopel-pronouns\n```\n\n## Configuring\n\nThe easiest way to configure `sopel-pronouns` is via Sopel's\nconfiguration wizard\u2014simply run `sopel-plugins configure pronouns`\nand enter the values for which it prompts you.\n\nOptions are:\n\n* `fetch_complete_list`: Whether to download the complete list of supported\n pronoun sets at startup\n * `fetch_url`: An optional custom fetch URL for the complete list (see below)\n* `link_base_url`: An optional custom base URL for links in the plugin's output\n\nThe `link_base_url` option allows you to use your own domain to host your own\ninstance of [our pronoun service][pronoun-service] hosted at\n[`pronouns.sopel.chat`][pronouns-instance], which is itself a fork of Lucas\nEduardo's [lovely little Svelte project][original-pronoun-service].\n\nIf you want to customize the available pronoun sets, set the `fetch_url` to your\nown instance's `pronouns.tab` file or an equivalent tab-delimited data source.\n\n[pronoun-service]: https://github.com/sopel-irc/pronoun-service\n[pronouns-instance]: https://pronouns.sopel.chat/\n[original-pronoun-service]: https://github.com/lucasew/svelte-pronounisland\n\n## Credits\n\n`sopel-pronouns` is based on the `pronouns.py` plugin that was built into Sopel\nfrom version 6.5.1 through 8.0. Special thanks to Elsie Powell and other\ncontributors to the original code, whose work can be viewed in the main Sopel\nrepository's [commit history][original-history].\n\n[original-history]: https://github.com/sopel-irc/sopel/commits/d4a0efde1a4bdea03be265d5e23591b553a0ce76/sopel/modules/pronouns.py\n\n## Changelog\n\n### 0.1.0\n\nFirst release of `sopel-pronouns`.\n\nNew standalone plugin based on the `pronouns` builtin from Sopel 8.0.0.\n\n**New feature:** Optionally fetch a custom `pronouns.tab` to match your own\n[pronoun service](https://github.com/sopel-irc/pronoun-service) instance. See\nREADME for details.\n",
"bugtrack_url": null,
"license": "EFL-2.0",
"summary": "Pronoun-sharing plugin for Sopel IRC bots",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/sopel-irc/sopel-pronouns/issues",
"Homepage": "https://github.com/sopel-irc/sopel-pronouns"
},
"split_keywords": [
"sopel",
" plugin",
" bot",
" irc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3092489d982c05206acf275f80bd612e897714d936adf70f8ec8007c45d18006",
"md5": "ecfe7319187376cc363e8efe76fb3846",
"sha256": "f8ae48b35fa6cf2f5a61154558611775f11936f03c6f83bcb294c20e4d15f55e"
},
"downloads": -1,
"filename": "sopel_pronouns-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ecfe7319187376cc363e8efe76fb3846",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 6625,
"upload_time": "2024-07-08T22:10:34",
"upload_time_iso_8601": "2024-07-08T22:10:34.890897Z",
"url": "https://files.pythonhosted.org/packages/30/92/489d982c05206acf275f80bd612e897714d936adf70f8ec8007c45d18006/sopel_pronouns-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "82ef967bc39eb887a83197aa64d63e46fdb83b0ec540aee80020403ee9692dc3",
"md5": "560d28a7a2439e33b2d8525fb3352b8e",
"sha256": "f967b13ce31b18eee03eee11f7fac274d053264d717ca4db47860cd91111813c"
},
"downloads": -1,
"filename": "sopel_pronouns-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "560d28a7a2439e33b2d8525fb3352b8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 6270,
"upload_time": "2024-07-08T22:10:36",
"upload_time_iso_8601": "2024-07-08T22:10:36.285249Z",
"url": "https://files.pythonhosted.org/packages/82/ef/967bc39eb887a83197aa64d63e46fdb83b0ec540aee80020403ee9692dc3/sopel_pronouns-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 22:10:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sopel-irc",
"github_project": "sopel-pronouns",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sopel-pronouns"
}
