sopel-rainbow

Name	sopel-rainbow JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	A Sopel plugin to make things RAINBOW COLORED.
upload_time	2024-09-25 21:34:22
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-rainbow

A Sopel plugin to make things RAINBOW COLORED.

## Installing

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

```shell
$ pip install sopel-rainbow
```

## Configuring

The easiest way to configure `sopel-rainbow` is via Sopel's configuration
wizard—simply run `sopel-plugins configure rainbow` and enter the values for
which it prompts you.

### `order` setting

By default, `sopel-rainbow` outputs colors in the "standard" rainbow `order`,
ROYGBIV, subject to receiving clients' use of the customary meanings for IRC
color codes 0-15. If set explicitly in your Sopel config file, this default
value would look like:

```ini
[rainbow]
order =
    4
    7
    8
    3
    12
    2
    6
```

If you want to get creative (or cater to a community with shared color norms
that differ from the "de facto" values established by mIRC and friends)
override the `order` with your own list of _numeric_ codes:

```ini
[rainbow]
order = # Americans and French can fight over this one
    4
    0
    2
```

### `random_start` setting

Starting the rainbow at the beginning of the `order` every time is also
default behavior. If you want the rainbow to start at a random place every
time instead, set the Boolean option `random_start` to `yes` or `on`:

```ini
[rainbow]
random_start = on
```

## Dependencies

* Sopel version 7.1 or higher
* Python 3.8 or higher

Sopel 7.x should still run on Python 2.7 or older Python 3 releases, but it's
not maintained any more; and neither is this plugin tested on anything older.

## Changelog

The brief, illustrious history of `sopel-rainbow`, a silly little plugin
spawned from [a tongue-in-cheek
upstream issue](https://github.com/sopel-irc/sopel/issues/1962).


### sopel-rainbow 0.2.0

Changed:

* Dropped support for Sopel<7.1 + Python<3.8
  * `sopel.module` -> `sopel.plugin`
  * Removed shim around `sopel.formatting.plain()` function
  * Updated `__future__` imports
  * Removed UTF-8 coding comment

Added:

* Use `unicodedata2` if it's installed

Fixed:

* `random_start` setting (broken by changes in [#1][])
* Errors in `sopel-plugins configure rainbow`
  * Wrong setting name (`rainbow` -> `order`)
  * Wrong default value type (`list[int]` -> `list[str]`)

Meta:

* Reorganized to match current Sopel standard (mainly putting "the
  actual plugin" in a `plugin.py` file, not `__init__.py`)
* Updated packaging to use `pyproject.toml` metadata
* Added release automation using PyPI Trusted Publishing

[#1]: https://github.com/sopel-irc/sopel-rainbow/pull/1


### sopel-rainbow 0.1.1

Fixed:

* Empty input raises exception on upcoming Sopel 7.1 release ([#2][])

[#2]: https://github.com/sopel-irc/sopel-rainbow/pull/2


### sopel-rainbow 0.1.0

Initial release, featuring:

* `.rainbow` command
* Configurable color order
* Optional randomized start point
* Control-code stripping on Sopel 7.1+
* Compatible with Sopel 7.0 through (planned) 8.x releases

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sopel-rainbow",
    "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/01/a9/206810ba3f62c79288a25c184d0db17d17e87a43ea5172e25dfcfa2c032d/sopel_rainbow-0.2.0.tar.gz",
    "platform": "Linux x86, x86-64",
    "description": "# sopel-rainbow\n\nA Sopel plugin to make things RAINBOW COLORED.\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-rainbow\n```\n\n## Configuring\n\nThe easiest way to configure `sopel-rainbow` is via Sopel's configuration\nwizard\u2014simply run `sopel-plugins configure rainbow` and enter the values for\nwhich it prompts you.\n\n### `order` setting\n\nBy default, `sopel-rainbow` outputs colors in the \"standard\" rainbow `order`,\nROYGBIV, subject to receiving clients' use of the customary meanings for IRC\ncolor codes 0-15. If set explicitly in your Sopel config file, this default\nvalue would look like:\n\n```ini\n[rainbow]\norder =\n    4\n    7\n    8\n    3\n    12\n    2\n    6\n```\n\nIf you want to get creative (or cater to a community with shared color norms\nthat differ from the \"de facto\" values established by mIRC and friends)\noverride the `order` with your own list of _numeric_ codes:\n\n```ini\n[rainbow]\norder = # Americans and French can fight over this one\n    4\n    0\n    2\n```\n\n### `random_start` setting\n\nStarting the rainbow at the beginning of the `order` every time is also\ndefault behavior. If you want the rainbow to start at a random place every\ntime instead, set the Boolean option `random_start` to `yes` or `on`:\n\n```ini\n[rainbow]\nrandom_start = on\n```\n\n## Dependencies\n\n* Sopel version 7.1 or higher\n* Python 3.8 or higher\n\nSopel 7.x should still run on Python 2.7 or older Python 3 releases, but it's\nnot maintained any more; and neither is this plugin tested on anything older.\n\n## Changelog\n\nThe brief, illustrious history of `sopel-rainbow`, a silly little plugin\nspawned from [a tongue-in-cheek\nupstream issue](https://github.com/sopel-irc/sopel/issues/1962).\n\n\n### sopel-rainbow 0.2.0\n\nChanged:\n\n* Dropped support for Sopel<7.1 + Python<3.8\n  * `sopel.module` -> `sopel.plugin`\n  * Removed shim around `sopel.formatting.plain()` function\n  * Updated `__future__` imports\n  * Removed UTF-8 coding comment\n\nAdded:\n\n* Use `unicodedata2` if it's installed\n\nFixed:\n\n* `random_start` setting (broken by changes in [#1][])\n* Errors in `sopel-plugins configure rainbow`\n  * Wrong setting name (`rainbow` -> `order`)\n  * Wrong default value type (`list[int]` -> `list[str]`)\n\nMeta:\n\n* Reorganized to match current Sopel standard (mainly putting \"the\n  actual plugin\" in a `plugin.py` file, not `__init__.py`)\n* Updated packaging to use `pyproject.toml` metadata\n* Added release automation using PyPI Trusted Publishing\n\n[#1]: https://github.com/sopel-irc/sopel-rainbow/pull/1\n\n\n### sopel-rainbow 0.1.1\n\nFixed:\n\n* Empty input raises exception on upcoming Sopel 7.1 release ([#2][])\n\n[#2]: https://github.com/sopel-irc/sopel-rainbow/pull/2\n\n\n### sopel-rainbow 0.1.0\n\nInitial release, featuring:\n\n* `.rainbow` command\n* Configurable color order\n* Optional randomized start point\n* Control-code stripping on Sopel 7.1+\n* Compatible with Sopel 7.0 through (planned) 8.x releases\n",
    "bugtrack_url": null,
    "license": "EFL-2.0",
    "summary": "A Sopel plugin to make things RAINBOW COLORED.",
    "version": "0.2.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/sopel-irc/sopel-rainbow/issues",
        "Homepage": "https://github.com/sopel-irc/sopel-rainbow"
    },
    "split_keywords": [
        "sopel",
        " plugin",
        " bot",
        " irc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1024497b5910adad6f712967c321b17d45170605388b5f059d0d0f69a2cc87d5",
                "md5": "7bb30782e1d074bd85fd9f5acf718c24",
                "sha256": "06abc3a29078aa9dab05a05abcbbfc77d4e0941498d4e8548ab551fe77af9d0f"
            },
            "downloads": -1,
            "filename": "sopel_rainbow-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7bb30782e1d074bd85fd9f5acf718c24",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.8",
            "size": 5060,
            "upload_time": "2024-09-25T21:34:21",
            "upload_time_iso_8601": "2024-09-25T21:34:21.332248Z",
            "url": "https://files.pythonhosted.org/packages/10/24/497b5910adad6f712967c321b17d45170605388b5f059d0d0f69a2cc87d5/sopel_rainbow-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "01a9206810ba3f62c79288a25c184d0db17d17e87a43ea5172e25dfcfa2c032d",
                "md5": "aa302890825afa672b3abeaa76b420ed",
                "sha256": "ec78cad58cba710b045f09ba6bf7f96151ea3e2710e7574646e2b999169b7f7f"
            },
            "downloads": -1,
            "filename": "sopel_rainbow-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "aa302890825afa672b3abeaa76b420ed",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.8",
            "size": 4732,
            "upload_time": "2024-09-25T21:34:22",
            "upload_time_iso_8601": "2024-09-25T21:34:22.635758Z",
            "url": "https://files.pythonhosted.org/packages/01/a9/206810ba3f62c79288a25c184d0db17d17e87a43ea5172e25dfcfa2c032d/sopel_rainbow-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-25 21:34:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sopel-irc",
    "github_project": "sopel-rainbow",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sopel-rainbow"
}