twitchirc-drgreengiant


Nametwitchirc-drgreengiant JSON
Version 2.1.0 PyPI version JSON
download
home_page
SummaryA simple receive only Twitch IRC client
upload_time2024-02-13 20:55:33
maintainer
docs_urlNone
author
requires_python>=3.11.4
license
keywords twitch irc chat
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # TwitchIRC

[![CodeQL Vulnerabilities](https://github.com/howroyd/twitchirc/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/howroyd/twitchirc/actions/workflows/codeql-analysis.yml)\
[![Linting and Testing](https://github.com/howroyd/twitchirc/actions/workflows/python-testing.yml/badge.svg)](https://github.com/howroyd/twitchirc/actions/workflows/python-testing.yml)\
[![Build and Release](https://github.com/howroyd/twitchirc/actions/workflows/python-publish.yml/badge.svg)](https://github.com/howroyd/twitchirc/actions/workflows/python-publish.yml)

This module connects to the Twitch IRC as a basic listener client.  It handles the ping pong and initial connection but otherwise does not send anything to Twitch therefore does not appear in the viewer list nor can it post to chat.  As such, no oauth is required, it just works out of the box.

It can join multiple channels at the same time and will report which channel a message was received in.

## Installation

Available on PyPi at https://pypi.org/project/twitchirc-drgreengiant/

```bash
pip install twitchirc_drgreengiant
```

## Typical Usage

```python
from twitchirc_drgreengiant import twitchirc

channels = frozenset(["drgreengiant", "hpxdreamer"])

with twitchirc.TwitchIrc(channels) as irc:
    while True:
        msg = irc.get_message(irc)

        if not msg:
            continue

        print("Received a message:")
        print(f"{msg.channel=} from {msg.username=}")
        print(f"{msg.payload=}")
        print()
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "twitchirc-drgreengiant",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11.4",
    "maintainer_email": "",
    "keywords": "twitch,irc,chat",
    "author": "",
    "author_email": "Simon Howroyd <howroydlsu@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/d0/03/2da191d1d8d4723a5f09ebe0ba075a414faa58dc4c6d46d7fb4a3691eefd/twitchirc_drgreengiant-2.1.0.tar.gz",
    "platform": null,
    "description": "# TwitchIRC\n\n[![CodeQL Vulnerabilities](https://github.com/howroyd/twitchirc/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/howroyd/twitchirc/actions/workflows/codeql-analysis.yml)\\\n[![Linting and Testing](https://github.com/howroyd/twitchirc/actions/workflows/python-testing.yml/badge.svg)](https://github.com/howroyd/twitchirc/actions/workflows/python-testing.yml)\\\n[![Build and Release](https://github.com/howroyd/twitchirc/actions/workflows/python-publish.yml/badge.svg)](https://github.com/howroyd/twitchirc/actions/workflows/python-publish.yml)\n\nThis module connects to the Twitch IRC as a basic listener client.  It handles the ping pong and initial connection but otherwise does not send anything to Twitch therefore does not appear in the viewer list nor can it post to chat.  As such, no oauth is required, it just works out of the box.\n\nIt can join multiple channels at the same time and will report which channel a message was received in.\n\n## Installation\n\nAvailable on PyPi at https://pypi.org/project/twitchirc-drgreengiant/\n\n```bash\npip install twitchirc_drgreengiant\n```\n\n## Typical Usage\n\n```python\nfrom twitchirc_drgreengiant import twitchirc\n\nchannels = frozenset([\"drgreengiant\", \"hpxdreamer\"])\n\nwith twitchirc.TwitchIrc(channels) as irc:\n    while True:\n        msg = irc.get_message(irc)\n\n        if not msg:\n            continue\n\n        print(\"Received a message:\")\n        print(f\"{msg.channel=} from {msg.username=}\")\n        print(f\"{msg.payload=}\")\n        print()\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A simple receive only Twitch IRC client",
    "version": "2.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/howroyd/twitchirc/issues",
        "Homepage": "https://github.com/howroyd/twitchirc",
        "Repository": "https://github.com/howroyd/twitchirc"
    },
    "split_keywords": [
        "twitch",
        "irc",
        "chat"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8b9771cc6ca135708c75c7fd59167f7dd385c020664e7d08beed2d501e6d1d0f",
                "md5": "f0ae04f964857ff68688d097a21f7fd8",
                "sha256": "8c0c2679bb8eb9172b903ed63818e73f9174c40b3504927cbd58d70f2f1e4c8b"
            },
            "downloads": -1,
            "filename": "twitchirc_drgreengiant-2.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f0ae04f964857ff68688d097a21f7fd8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11.4",
            "size": 14577,
            "upload_time": "2024-02-13T20:55:32",
            "upload_time_iso_8601": "2024-02-13T20:55:32.174177Z",
            "url": "https://files.pythonhosted.org/packages/8b/97/71cc6ca135708c75c7fd59167f7dd385c020664e7d08beed2d501e6d1d0f/twitchirc_drgreengiant-2.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d0032da191d1d8d4723a5f09ebe0ba075a414faa58dc4c6d46d7fb4a3691eefd",
                "md5": "e26e4470ef118329e7d34c5c4a6648f9",
                "sha256": "6020dfe228ca136ae8cb22f250d2c1f9798d964381609206a9d15c3479ae1dce"
            },
            "downloads": -1,
            "filename": "twitchirc_drgreengiant-2.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e26e4470ef118329e7d34c5c4a6648f9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11.4",
            "size": 14115,
            "upload_time": "2024-02-13T20:55:33",
            "upload_time_iso_8601": "2024-02-13T20:55:33.853292Z",
            "url": "https://files.pythonhosted.org/packages/d0/03/2da191d1d8d4723a5f09ebe0ba075a414faa58dc4c6d46d7fb4a3691eefd/twitchirc_drgreengiant-2.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-13 20:55:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "howroyd",
    "github_project": "twitchirc",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "twitchirc-drgreengiant"
}
        
Elapsed time: 5.01928s