| Name | sopel-rulesof JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | "Rules of X" plugins for Sopel IRC bots. |
| upload_time | 2025-02-23 03:16:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| 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-rulesof
"Rules of X" plugins for Sopel IRC bots.
## Installing
Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:
```shell
$ pip install sopel-rulesof
```
[**Depending on your Sopel bot's configuration**][sopel-endis-plugins], you
might need to enable or disable the specific `rules_of_x` plugins ([see
below](#available-rule-collections)) that you want your bot to use. You
can do so with [the `sopel-plugins` command][cli-sopel-plugins], e.g.:
```shell
$ sopel-plugins enable rules_of_acquisition
```
[cli-sopel-plugins]: https://sopel.chat/docs/run/cli.html#sopel-plugins
[sopel-endis-plugins]: https://sopel.chat/docs/run/plugin#enabling-or-disabling-plugins
### Available rule collections
* `rules_of_acquisition`: The Ferengi Rules of Acquisition
* `rules_of_the_internet`: The Rules of the Internet (Rule 34 & friends)
### Installation requirements
The `sopel-rulesof` package is written with Python 3 and Sopel 8.0+ in mind.
Installation on Python 2, or usage with Sopel 7.x, is not supported.
## Using
### `rules_of_acquisition`
Commands:
* `.roa`
* Call without arguments to grab a random Rule of Acquisition
* Call with a single number to print that specific Rule (e.g. `.roa 153`)
* Call with a word or phrase to pick a random rule containing it (e.g. `.roa
justification`)
### `rules_of_the_internet`
Commands:
* `.roti`
* Call without arguments to grab a random Rule of the Internet
* Call with a single number to print that specific Rule (e.g. `.roti 34`)
* Call with a word or phrase to pick a random rule containing it (e.g. `.roti
talk about`)
## Changelog
### 0.1.0
First release of `sopel-rulesof` plugin collection.
Launch plugins are `rules_of_acquisition` and `rules_of_the_internet`.
Raw data
{
"_id": null,
"home_page": null,
"name": "sopel-rulesof",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "sopel, plugin, bot, irc",
"author": null,
"author_email": "dgw <dgw@technobabbl.es>",
"download_url": "https://files.pythonhosted.org/packages/b8/0a/4510b6685b9b6f5cca88d5be65ae09655d983c6e0a9372d647318e24c7c4/sopel_rulesof-0.1.0.tar.gz",
"platform": "Linux x86, x86-64",
"description": "# sopel-rulesof\n\n\"Rules of X\" plugins 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-rulesof\n```\n\n[**Depending on your Sopel bot's configuration**][sopel-endis-plugins], you\nmight need to enable or disable the specific `rules_of_x` plugins ([see\nbelow](#available-rule-collections)) that you want your bot to use. You\ncan do so with [the `sopel-plugins` command][cli-sopel-plugins], e.g.:\n\n```shell\n$ sopel-plugins enable rules_of_acquisition\n```\n\n[cli-sopel-plugins]: https://sopel.chat/docs/run/cli.html#sopel-plugins\n[sopel-endis-plugins]: https://sopel.chat/docs/run/plugin#enabling-or-disabling-plugins\n\n### Available rule collections\n\n* `rules_of_acquisition`: The Ferengi Rules of Acquisition\n* `rules_of_the_internet`: The Rules of the Internet (Rule 34 & friends)\n\n### Installation requirements\n\nThe `sopel-rulesof` package is written with Python 3 and Sopel 8.0+ in mind.\nInstallation on Python 2, or usage with Sopel 7.x, is not supported.\n\n## Using\n\n### `rules_of_acquisition`\n\nCommands:\n\n* `.roa`\n * Call without arguments to grab a random Rule of Acquisition\n * Call with a single number to print that specific Rule (e.g. `.roa 153`)\n * Call with a word or phrase to pick a random rule containing it (e.g. `.roa\n justification`)\n\n### `rules_of_the_internet`\n\nCommands:\n\n* `.roti`\n * Call without arguments to grab a random Rule of the Internet\n * Call with a single number to print that specific Rule (e.g. `.roti 34`)\n * Call with a word or phrase to pick a random rule containing it (e.g. `.roti\n talk about`)\n\n## Changelog\n\n### 0.1.0\n\nFirst release of `sopel-rulesof` plugin collection.\n\nLaunch plugins are `rules_of_acquisition` and `rules_of_the_internet`.\n",
"bugtrack_url": null,
"license": "EFL-2.0",
"summary": "\"Rules of X\" plugins for Sopel IRC bots.",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/dgw/sopel-rulesof/issues",
"Homepage": "https://github.com/dgw/sopel-rulesof"
},
"split_keywords": [
"sopel",
" plugin",
" bot",
" irc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20c881383da565df8764fe2f965d8cc9f1f22e65b1496b6462a8350e7e6fa350",
"md5": "8be0f88314bb518fd3714b8c6e728944",
"sha256": "0f98c2089c29464b1da4f0332b0b278aa716903fc72c679ec8f354579bb542c6"
},
"downloads": -1,
"filename": "sopel_rulesof-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8be0f88314bb518fd3714b8c6e728944",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 8903,
"upload_time": "2025-02-23T03:16:12",
"upload_time_iso_8601": "2025-02-23T03:16:12.137666Z",
"url": "https://files.pythonhosted.org/packages/20/c8/81383da565df8764fe2f965d8cc9f1f22e65b1496b6462a8350e7e6fa350/sopel_rulesof-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b80a4510b6685b9b6f5cca88d5be65ae09655d983c6e0a9372d647318e24c7c4",
"md5": "1e984202e86bcc1e27e8d10fec07b7dc",
"sha256": "e66b464f23d0ee615f6dfa36a8efec825a70026adc4523fd4309f0af47febc60"
},
"downloads": -1,
"filename": "sopel_rulesof-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1e984202e86bcc1e27e8d10fec07b7dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 7111,
"upload_time": "2025-02-23T03:16:15",
"upload_time_iso_8601": "2025-02-23T03:16:15.766578Z",
"url": "https://files.pythonhosted.org/packages/b8/0a/4510b6685b9b6f5cca88d5be65ae09655d983c6e0a9372d647318e24c7c4/sopel_rulesof-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-23 03:16:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dgw",
"github_project": "sopel-rulesof",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sopel-rulesof"
}
