| Name | sopel-amputator JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Sopel plugin that detects AMP links and finds their canonical forms using AmputatorBot |
| upload_time | 2024-04-13 18:48: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-amputator
Sopel plugin that detects AMP links and finds their canonical forms using
[AmputatorBot](https://www.amputatorbot.com/)
## Installing
Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:
```shell
$ pip install sopel-amputator
```
## Configuring
The easiest way to configure `sopel-amputator` is via Sopel's
configuration wizard—simply run `sopel-plugins configure amputator`
and enter the values for which it prompts you.
Individual settings are described below.
### `ignore_domains`
This is a list of hostnames which `sopel-amputator` will ignore, even if they
match one of the common AMP substrings it looks for. By default it contains a
set of ignored domains from the AmputatorBot project.
The default list is _overridden_ when setting this value, so make sure to also
enter any of the default entries you want to keep.
## Changelog
### 0.2.0
Under-the-hood improvements:
* More robust domain matching against ignore list
* Includes distinct log messages for exact matches vs. subdomain matches
* More granular error handling
* Better error logging
* Migrated package metadata from `setup.py`+`setup.cfg` to `pyproject.toml`
### 0.1.0
Initial release.
Pending conversion from `setup.py`+`setup.cfg` template to newer style package
using `pyproject.toml`—plus some other features on the todo list—but the basics
are here:
* Detect likely AMP links
* Call AmputatorBot API for the canonical URL of each suspected AMP link
* Skip links from a configurable list of ignored domains
* Silently fail if no better URL is found
Raw data
{
"_id": null,
"home_page": null,
"name": "sopel-amputator",
"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/86/11/56038690cf5f0116117e50a101c295d210559b94800548d4cd47610468ba/sopel_amputator-0.2.0.tar.gz",
"platform": "Linux x86, x86-64",
"description": "# sopel-amputator\n\nSopel plugin that detects AMP links and finds their canonical forms using\n[AmputatorBot](https://www.amputatorbot.com/)\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-amputator\n```\n\n## Configuring\n\nThe easiest way to configure `sopel-amputator` is via Sopel's\nconfiguration wizard\u2014simply run `sopel-plugins configure amputator`\nand enter the values for which it prompts you.\n\nIndividual settings are described below.\n\n### `ignore_domains`\n\nThis is a list of hostnames which `sopel-amputator` will ignore, even if they\nmatch one of the common AMP substrings it looks for. By default it contains a\nset of ignored domains from the AmputatorBot project.\n\nThe default list is _overridden_ when setting this value, so make sure to also\nenter any of the default entries you want to keep.\n\n## Changelog\n\n### 0.2.0\n\nUnder-the-hood improvements:\n\n* More robust domain matching against ignore list\n * Includes distinct log messages for exact matches vs. subdomain matches\n* More granular error handling\n* Better error logging\n* Migrated package metadata from `setup.py`+`setup.cfg` to `pyproject.toml`\n\n\n### 0.1.0\n\nInitial release.\n\nPending conversion from `setup.py`+`setup.cfg` template to newer style package\nusing `pyproject.toml`\u2014plus some other features on the todo list\u2014but the basics\nare here:\n\n* Detect likely AMP links\n* Call AmputatorBot API for the canonical URL of each suspected AMP link\n* Skip links from a configurable list of ignored domains\n* Silently fail if no better URL is found\n",
"bugtrack_url": null,
"license": "EFL-2.0",
"summary": "Sopel plugin that detects AMP links and finds their canonical forms using AmputatorBot",
"version": "0.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/dgw/sopel-amputator/issues",
"Homepage": "https://github.com/dgw/sopel-amputator"
},
"split_keywords": [
"sopel",
" plugin",
" bot",
" irc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2dc7eedf5b5c934326904ce590c6ad6b8914af55a6bdc4bfa8a5b2a42d51a62a",
"md5": "7010862927aa2d56d68a026954c4bb11",
"sha256": "b577f80592356367d2cb9a1cb641821edb5fc3a8ba08e885b4c51944a3aa2c10"
},
"downloads": -1,
"filename": "sopel_amputator-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7010862927aa2d56d68a026954c4bb11",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 5021,
"upload_time": "2024-04-13T18:48:49",
"upload_time_iso_8601": "2024-04-13T18:48:49.377487Z",
"url": "https://files.pythonhosted.org/packages/2d/c7/eedf5b5c934326904ce590c6ad6b8914af55a6bdc4bfa8a5b2a42d51a62a/sopel_amputator-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "861156038690cf5f0116117e50a101c295d210559b94800548d4cd47610468ba",
"md5": "70cfeae13eb841739afaaccf2a5fab72",
"sha256": "2a882b89907594b3a5b0da47191316a728fa850bbfb959d610d01e34c700ee25"
},
"downloads": -1,
"filename": "sopel_amputator-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "70cfeae13eb841739afaaccf2a5fab72",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 4711,
"upload_time": "2024-04-13T18:48:50",
"upload_time_iso_8601": "2024-04-13T18:48:50.763283Z",
"url": "https://files.pythonhosted.org/packages/86/11/56038690cf5f0116117e50a101c295d210559b94800548d4cd47610468ba/sopel_amputator-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-13 18:48:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dgw",
"github_project": "sopel-amputator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sopel-amputator"
}
