sopel-boorus


Namesopel-boorus JSON
Version 0.1.3 PyPI version JSON
download
home_pageNone
SummaryImage board (booru) plugins for Sopel IRC bots.
upload_time2024-10-31 00:59:33
maintainerNone
docs_urlNone
authorNone
requires_python<4,>=3.8
licenseEFL-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-boorus

Image board (booru) plugins for Sopel IRC bots.

## Installing

Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:

```shell
$ pip install sopel-boorus
```

[**Depending on your Sopel bot's configuration**][sopel-endis-plugins], you
might need to enable or disable the specific booru plugins ([see
below](#booru-plugins-in-this-collection)) 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 gelbooru
```

[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

### Booru plugins in this collection

* `danbooru`: Supports Danbooru (https://danbooru.donmai.us) links & searches
* `gelbooru`: Supports Gelbooru (https://gelbooru.com) links & searches

### Installation requirements

The `sopel-boorus` 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

### `danbooru`

**Note: Danbooru strictly limits search capabilities for anonymous users,**
making this plugin more useful for link handling than searching, though it will
be able to handle a tag or two just fine if you want a random pic.

Commands: `.danb` or `.danbooru` to search for a random post by tag(s)

Links: Handles post links, e.g. `https://danbooru.donmai.us/posts/<post_id>`

### `gelbooru`

Commands: `.gelb` or `.gelbooru` to search for a random post by tag(s)

Links: Handles post links, e.g.
`https://gelbooru.com/index.php?page=post&s=view&id=<post_id>`

## Changelog

### 0.1.3

Fixed:
* URL pattern for `danbooru` became *too* strict ([#9][])

[#9]: https://github.com/dgw/sopel-boorus/pull/9


### 0.1.2

Changed:
* URL patterns are stricter ([#8][])

Fixed:
* Unescape HTML entities in tag names ([#7][])
* Corrected post rating colors ([#3][])

[#3]: https://github.com/dgw/sopel-boorus/pull/3
[#7]: https://github.com/dgw/sopel-boorus/pull/7
[#8]: https://github.com/dgw/sopel-boorus/pull/8


### 0.1.1

Fixed:
* Handle more error cases ([#1][])

[#1]: https://github.com/dgw/sopel-boorus/pull/1


### 0.1.0

First release of `sopel-boorus` plugin collection.

Launch plugins are `danbooru` and `gelbooru`.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sopel-boorus",
    "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/97/9e/cf2fa2d58669d18f420632f6cb840dcee9709024e868f97bfc367e656d15/sopel_boorus-0.1.3.tar.gz",
    "platform": "Linux x86, x86-64",
    "description": "# sopel-boorus\n\nImage board (booru) 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-boorus\n```\n\n[**Depending on your Sopel bot's configuration**][sopel-endis-plugins], you\nmight need to enable or disable the specific booru plugins ([see\nbelow](#booru-plugins-in-this-collection)) 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 gelbooru\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### Booru plugins in this collection\n\n* `danbooru`: Supports Danbooru (https://danbooru.donmai.us) links & searches\n* `gelbooru`: Supports Gelbooru (https://gelbooru.com) links & searches\n\n### Installation requirements\n\nThe `sopel-boorus` 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### `danbooru`\n\n**Note: Danbooru strictly limits search capabilities for anonymous users,**\nmaking this plugin more useful for link handling than searching, though it will\nbe able to handle a tag or two just fine if you want a random pic.\n\nCommands: `.danb` or `.danbooru` to search for a random post by tag(s)\n\nLinks: Handles post links, e.g. `https://danbooru.donmai.us/posts/<post_id>`\n\n### `gelbooru`\n\nCommands: `.gelb` or `.gelbooru` to search for a random post by tag(s)\n\nLinks: Handles post links, e.g.\n`https://gelbooru.com/index.php?page=post&s=view&id=<post_id>`\n\n## Changelog\n\n### 0.1.3\n\nFixed:\n* URL pattern for `danbooru` became *too* strict ([#9][])\n\n[#9]: https://github.com/dgw/sopel-boorus/pull/9\n\n\n### 0.1.2\n\nChanged:\n* URL patterns are stricter ([#8][])\n\nFixed:\n* Unescape HTML entities in tag names ([#7][])\n* Corrected post rating colors ([#3][])\n\n[#3]: https://github.com/dgw/sopel-boorus/pull/3\n[#7]: https://github.com/dgw/sopel-boorus/pull/7\n[#8]: https://github.com/dgw/sopel-boorus/pull/8\n\n\n### 0.1.1\n\nFixed:\n* Handle more error cases ([#1][])\n\n[#1]: https://github.com/dgw/sopel-boorus/pull/1\n\n\n### 0.1.0\n\nFirst release of `sopel-boorus` plugin collection.\n\nLaunch plugins are `danbooru` and `gelbooru`.\n",
    "bugtrack_url": null,
    "license": "EFL-2.0",
    "summary": "Image board (booru) plugins for Sopel IRC bots.",
    "version": "0.1.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/dgw/sopel-boorus/issues",
        "Homepage": "https://github.com/dgw/sopel-boorus"
    },
    "split_keywords": [
        "sopel",
        " plugin",
        " bot",
        " irc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "948700507f7987edca07bfa271daa3d4e399acf3d2530d092de031113128ed2f",
                "md5": "7b025831aa34efd52df7e0b42c56bf0e",
                "sha256": "9dd6c2b78823dbaf843a8cefb0dde0f5af59c128d41e6a060fdf90719e2d24d3"
            },
            "downloads": -1,
            "filename": "sopel_boorus-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7b025831aa34efd52df7e0b42c56bf0e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.8",
            "size": 12307,
            "upload_time": "2024-10-31T00:59:32",
            "upload_time_iso_8601": "2024-10-31T00:59:32.854879Z",
            "url": "https://files.pythonhosted.org/packages/94/87/00507f7987edca07bfa271daa3d4e399acf3d2530d092de031113128ed2f/sopel_boorus-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "979ecf2fa2d58669d18f420632f6cb840dcee9709024e868f97bfc367e656d15",
                "md5": "b86b429be90d2f9a28ffb768bec4fa01",
                "sha256": "15288502298c078bc98112caffca58c1af61473a68aef13cf556300182e7197a"
            },
            "downloads": -1,
            "filename": "sopel_boorus-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "b86b429be90d2f9a28ffb768bec4fa01",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.8",
            "size": 9702,
            "upload_time": "2024-10-31T00:59:33",
            "upload_time_iso_8601": "2024-10-31T00:59:33.790291Z",
            "url": "https://files.pythonhosted.org/packages/97/9e/cf2fa2d58669d18f420632f6cb840dcee9709024e868f97bfc367e656d15/sopel_boorus-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-31 00:59:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "dgw",
    "github_project": "sopel-boorus",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sopel-boorus"
}
        
Elapsed time: 1.17936s