| Name | sopel-wolfram JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | None |
| Summary | Wolfram|Alpha plugin for the Sopel IRC bot framework |
| upload_time | 2024-07-07 23:06:50 |
| 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-wolfram
Wolfram|Alpha plugin for the Sopel IRC bot framework
## Installing
Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:
```shell
$ pip install sopel-wolfram
```
### Requirements
* Sopel 8.x
* wolframalpha 5.x
You will also need a Wolfram|Alpha App ID; see details below in the
"Configuring" section.
## Configuring
The easiest way to configure `sopel-wolfram` is via Sopel's
configuration wizard—simply run `sopel-plugins configure wolfram`
and enter the values for which it prompts you.
However, you can manually add the following section to your Sopel bot's
configuration file if desired:
```ini
[wolfram]
app_id = yourappidgoeshere
```
The `app_id` setting is required, and you will need to get your own App ID from
Wolfram|Alpha at https://developer.wolframalpha.com/
Optional settings:
* `max_public`: the number of lines over which results will be sent in NOTICE
instead of to the channel (default: 5)
* `units`: measurement system displayed in results, either `metric` (the
default) or `nonmetric`
## Example usage
```
<User> .wa 2+2
<Sopel> [W|A] 2+2 = 4
<User> .wa python language release date
<Sopel> [W|A] Python | date introduced = 1991
<User> .wa airspeed velocity of an unladen swallow
<Sopel> [W|A] estimated average cruising airspeed of an unladen European
swallow = 25 mph (miles per hour)(asked, but not answered, about a
general swallow in the 1975 film Monty Python and the Holy Grail)
```
## Changelog
Ticket numbers in changelog entries can be looked up by visiting
`https://github.com/dgw/sopel-wolfram/issue/<number>`
### 0.6.0 "Bocchi de Skip"
First release as `sopel-wolfram`, replacing the old `sopel_modules.wolfram`
package for Sopel 7 and older.
Updated:
* Sopel 8.x and Python 3.8+ now required (#25)
* Upgraded to `wolframalpha` 5.x (#25)
* Modernized packaging & package metadata (#25)
* Streamlined documentation (#25)
### 0.5.0 "ALIVE"
That's "ALIVE" as in "This project isn't DEAD" (despite the last release being
over two years old).
Updated:
* Sopel 7.x now supported & required (#23)
* Dropped support for Sopel 6.x (#23)
* Dropped support for wolframalpha 2.x (#23)
* Internal refactoring to take advantage of new Sopel features (#23)
Meta:
* No more ZIP releases; PyPI only allows one file type now (#22)
### 0.4.1 "Kibou ni tsuite"
This release named in memory of LuckyNumber78, who changed lives every day simply
by being her excitable, fun-loving self. She is missed by many.
Fixed:
* `max_public` setting could cause errors because it was treated as a string (#21)
### 0.4.0 "Mirai no kajitsu"
Added:
* Support for wolframalpha 3.0 with transitional fallback to 2.4 (#11, #19; see
README notes)
* New configuration option `max_public`, a number defining the maximum number of
lines that can be sent without using NOTICEs. Default: 5 (#13)
* New configuration option `units`, to specify whether the API should return
`metric` (default) or `nonmetric` measurements (#18; see #16)
Updated:
* Threshold for using NOTICEs is now 5 lines, up from the previous default of 3
Fixed:
* Non-ASCII text in output is no longer `\:encoded` (#15)
### 0.3.1 "Nusumareta kuchibiru"
Updates:
* Unicode-encode query to avoid UnicodeEncodeError on non-ASCII characters (#10)
### 0.3.0 "So long!"
Updates:
* Results longer than 3 lines will be sent via NOTICE instead of flooding
channels (#8)
### 0.2.1 "Mae shika mukanee"
Updates:
* Output now split into multiple messages when line breaks are present (#4)
* Tell pip we do not want wolframalpha 3.0 yet (#6)
### 0.2.0 "Miraibashi"
Updates:
* Try a lot harder to give useful output (#3)
* Tell user to try again if an unspecified error occurs (empty error message)
Meta:
* Cleanup: PEP8 & unused imports
* Refactor to make future addition of integration tests easier
### 0.1.2 "Switch"
Updates:
* Shorten some error messages
* Identify as "[W|A]" instead of "[Wolfram]" in output for brevity
* Ensure all module output is prefixed
* Add more examples to help output and README
Meta:
* README now includes installation instructions and where to get help/report
bugs
### 0.1.1 "Already"
Updates:
* Now outputs error if `app_id` is missing (#1)
Meta:
* README reformatted (thanks @[maxpowa](https://github.com/maxpowa))
* Begin maintaining version history in NEWS file
### 0.1.0 "Beginner"
-------------------------------
* Initial release
* Adopted with permission from
https://github.com/maxpowa/inumuta-modules/blob/e0b195c/wolfram.py
Raw data
{
"_id": null,
"home_page": null,
"name": "sopel-wolfram",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": "dgw <dgw@technobabbl.es>",
"keywords": "sopel, plugin, bot, irc",
"author": null,
"author_email": "Max Gurela <maxpowa1@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8e/2a/ddc5adb6f377fe6b67d273272f6109cc6aa664e5a231091e45c0a80cb3a0/sopel_wolfram-0.6.0.tar.gz",
"platform": "Linux x86, x86-64",
"description": "# sopel-wolfram\n\nWolfram|Alpha plugin for the Sopel IRC bot framework\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-wolfram\n```\n\n### Requirements\n\n* Sopel 8.x\n* wolframalpha 5.x\n\nYou will also need a Wolfram|Alpha App ID; see details below in the\n\"Configuring\" section.\n\n\n## Configuring\n\nThe easiest way to configure `sopel-wolfram` is via Sopel's\nconfiguration wizard\u2014simply run `sopel-plugins configure wolfram`\nand enter the values for which it prompts you.\n\nHowever, you can manually add the following section to your Sopel bot's\nconfiguration file if desired:\n\n```ini\n[wolfram]\napp_id = yourappidgoeshere\n```\n\nThe `app_id` setting is required, and you will need to get your own App ID from\nWolfram|Alpha at https://developer.wolframalpha.com/\n\nOptional settings:\n\n* `max_public`: the number of lines over which results will be sent in NOTICE\n instead of to the channel (default: 5)\n* `units`: measurement system displayed in results, either `metric` (the\n default) or `nonmetric`\n\n\n## Example usage\n\n```\n<User> .wa 2+2\n<Sopel> [W|A] 2+2 = 4\n\n<User> .wa python language release date\n<Sopel> [W|A] Python | date introduced = 1991\n\n<User> .wa airspeed velocity of an unladen swallow\n<Sopel> [W|A] estimated average cruising airspeed of an unladen European\n swallow = 25 mph (miles per hour)(asked, but not answered, about a\n general swallow in the 1975 film Monty Python and the Holy Grail)\n```\n\n## Changelog\n\nTicket numbers in changelog entries can be looked up by visiting\n`https://github.com/dgw/sopel-wolfram/issue/<number>`\n\n\n### 0.6.0 \"Bocchi de Skip\"\n\nFirst release as `sopel-wolfram`, replacing the old `sopel_modules.wolfram`\npackage for Sopel 7 and older.\n\nUpdated:\n\n* Sopel 8.x and Python 3.8+ now required (#25)\n* Upgraded to `wolframalpha` 5.x (#25)\n* Modernized packaging & package metadata (#25)\n* Streamlined documentation (#25)\n\n\n### 0.5.0 \"ALIVE\"\n\nThat's \"ALIVE\" as in \"This project isn't DEAD\" (despite the last release being\nover two years old).\n\nUpdated:\n\n* Sopel 7.x now supported & required (#23)\n* Dropped support for Sopel 6.x (#23)\n* Dropped support for wolframalpha 2.x (#23)\n* Internal refactoring to take advantage of new Sopel features (#23)\n\nMeta:\n\n* No more ZIP releases; PyPI only allows one file type now (#22)\n\n\n### 0.4.1 \"Kibou ni tsuite\"\n\nThis release named in memory of LuckyNumber78, who changed lives every day simply\nby being her excitable, fun-loving self. She is missed by many.\n\nFixed:\n\n* `max_public` setting could cause errors because it was treated as a string (#21)\n\n\n### 0.4.0 \"Mirai no kajitsu\"\n\nAdded:\n\n* Support for wolframalpha 3.0 with transitional fallback to 2.4 (#11, #19; see\n README notes)\n* New configuration option `max_public`, a number defining the maximum number of\n lines that can be sent without using NOTICEs. Default: 5 (#13)\n* New configuration option `units`, to specify whether the API should return\n `metric` (default) or `nonmetric` measurements (#18; see #16)\n\nUpdated:\n\n* Threshold for using NOTICEs is now 5 lines, up from the previous default of 3\n\nFixed:\n\n* Non-ASCII text in output is no longer `\\:encoded` (#15)\n\n\n### 0.3.1 \"Nusumareta kuchibiru\"\n\nUpdates:\n\n* Unicode-encode query to avoid UnicodeEncodeError on non-ASCII characters (#10)\n\n\n### 0.3.0 \"So long!\"\n\nUpdates:\n\n* Results longer than 3 lines will be sent via NOTICE instead of flooding\n channels (#8)\n\n\n### 0.2.1 \"Mae shika mukanee\"\n\nUpdates:\n\n* Output now split into multiple messages when line breaks are present (#4)\n* Tell pip we do not want wolframalpha 3.0 yet (#6)\n\n\n### 0.2.0 \"Miraibashi\"\n\nUpdates:\n\n* Try a lot harder to give useful output (#3)\n* Tell user to try again if an unspecified error occurs (empty error message)\n\nMeta:\n\n* Cleanup: PEP8 & unused imports\n* Refactor to make future addition of integration tests easier\n\n\n### 0.1.2 \"Switch\"\n\nUpdates:\n\n* Shorten some error messages\n* Identify as \"[W|A]\" instead of \"[Wolfram]\" in output for brevity\n* Ensure all module output is prefixed\n* Add more examples to help output and README\n\nMeta:\n\n* README now includes installation instructions and where to get help/report\n bugs\n\n\n### 0.1.1 \"Already\"\n\nUpdates:\n\n* Now outputs error if `app_id` is missing (#1)\n\nMeta:\n\n* README reformatted (thanks @[maxpowa](https://github.com/maxpowa))\n* Begin maintaining version history in NEWS file\n\n\n### 0.1.0 \"Beginner\"\n-------------------------------\n\n* Initial release\n* Adopted with permission from\n https://github.com/maxpowa/inumuta-modules/blob/e0b195c/wolfram.py\n",
"bugtrack_url": null,
"license": "EFL-2.0",
"summary": "Wolfram|Alpha plugin for the Sopel IRC bot framework",
"version": "0.6.0",
"project_urls": {
"Bug Tracker": "https://github.com/dgw/sopel-wolfram/issues",
"Homepage": "https://github.com/dgw/sopel-wolfram"
},
"split_keywords": [
"sopel",
" plugin",
" bot",
" irc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4075d6002f6fb4c5b600b6020eb40888d2c2dd7702c612d04b4651cd666c0a90",
"md5": "1cc53f7ea5b9c63734b9ae5d515aa7ae",
"sha256": "35d5dcfa07f26a230b65eb1b0179a662854a69c6b3da7a636e5b7cf3823466c5"
},
"downloads": -1,
"filename": "sopel_wolfram-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1cc53f7ea5b9c63734b9ae5d515aa7ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 6374,
"upload_time": "2024-07-07T23:06:49",
"upload_time_iso_8601": "2024-07-07T23:06:49.502336Z",
"url": "https://files.pythonhosted.org/packages/40/75/d6002f6fb4c5b600b6020eb40888d2c2dd7702c612d04b4651cd666c0a90/sopel_wolfram-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e2addc5adb6f377fe6b67d273272f6109cc6aa664e5a231091e45c0a80cb3a0",
"md5": "7e5b18a70fed9675dcd44a677f024ee2",
"sha256": "2821c50af435e0225cb7f7bcc6370b0eaee16cad2a78bc2af47ed8fd05025c4c"
},
"downloads": -1,
"filename": "sopel_wolfram-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "7e5b18a70fed9675dcd44a677f024ee2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 6099,
"upload_time": "2024-07-07T23:06:50",
"upload_time_iso_8601": "2024-07-07T23:06:50.998698Z",
"url": "https://files.pythonhosted.org/packages/8e/2a/ddc5adb6f377fe6b67d273272f6109cc6aa664e5a231091e45c0a80cb3a0/sopel_wolfram-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-07 23:06:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dgw",
"github_project": "sopel-wolfram",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sopel-wolfram"
}
