{
    "info": {
        "author": "Matt Nishi-Broach",
        "author_email": "go.for.dover@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Environment :: Web Environment",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Topic :: Communications :: Chat :: Internet Relay Chat",
            "Topic :: Multimedia"
        ],
        "description": "[![Build Status](https://travis-ci.org/MattBroach/chat_transformer.svg?branch=master)](https://travis-ci.org/MattBroach/chat_transformer)\n[![PyPI version](https://badge.fury.io/py/chat-transformer.svg)](https://badge.fury.io/py/chat_transformer)\n\n# chat_transformer\n\nTranslates incoming IRC messages to OSC, HTTP, or any other output format you need.\n\n## Installation\n\n`chat_transformer` can be installed using `pip`:\n\n```python\npip install chat_transformer\n```\n\n## Set up\n\nYou must create a `json` file that specifies that mapping of IRC messages to output data. The file must contain a JSON object, where each KEY is an IRC command/message, and the VALUE is a JSON object with the parameters for converting the IRC message to OSC commands.  For example:\n\n```json\n{\n    \"brightness\": {\n        \"address\": \"/osc/brightness/\",\n        \"min\": 0.0,\n        \"max\": 2.0,\n        \"delta\": 0.1,\n        \"initial\": 1.0,\n        \"outputs\": {\n            \"osc\": {\"address\": \"/video/brightness\"},\n            \"http\": {\"command_name\": \"brightness\"}\n        }\n    },\n    ....\n}\n```\n\nWith the above targets data, the following IRC message:\n\n```\nbrightness set 0.75\n```\n\nwould translate to the following OSC Message:\n\n```\n/osc/brightness 0.75\n```\n\nand the following POST message to the main HTTP target:\n\n```\n{brightness: {\"value\": 0.75, \"min\": 0.0, \"max\": 2.0}}\n```\n\n## Usage\n\n`chat_transformer` can be run as a CLI command. At minimum, you must specify the location of a config file that will hold the various settings necessary for running `chat_transformer`: \n\n```bash\nchat_transformer --config /path/to/my/config.json\n```\n\nOr with the shorthand commands:\n\n```bash\nchat_transformer -c /path/to/my/config.json\n```\n\nRather than specifying options as command-line arguments, options can instead be set as environment variables:\n\n```bash\nexport CHAT_TRANSFORMER_CONFIG=/path/to/my/config.json\nchat_transformer\n```\n\n## Command Line Options\n\n| Argument | Env variable name | Description | Default |\n| -------- | ----------------- | ----------- | ------- |\n| -c, --config | CHAT_TRANSFORMER_CONFIG | filepath of the config JSON file | config.json\n| -v, --verbosity | | How verbose to make the output | 1 (Info) |\n\n## Configuration File\n\nThe configuration JSON file holds all the necessary settings for running your instance of `chat_transformer`. At bear minimum it must include an `irc` key with the server and login information, a `commands` key with information about the the commands JSON file (which contains the list of active commands to listen for and respond to), and at least one output (`osc` and `http` are supported out of the box).  Here's an example of a minimal configuration file that's listening to freenode:\n\n```json\n{\n    \"irc\": {\n        \"server\": \"chat.freenode.net\"\n    },\n    \"commands\": {\n        \"filename\": \"/path/to/my/commands.json\"\n    },\n    \"outputs\": {\n        \"osc\": {\n            \"port\": 9876\n        }\n    }\n}\n```\n\n## Configuration File Ooptions\n\n| Key   | Description | Default |\n| ----- | ----------- | ------- |\n| `irc.server` | Server address of the IRC Server | None (**Required**) |\n| `irc.port` | Port number of the IRC Server | 6667 |\n| `irc.nickname` | Nickname for authnenticating on IRC | None (**Required**) |\n| `irc.password` | Password for authentication on the IRC server | |\n| `irc.username` | Username for authentication on the IRC server | `irc.nickname` (above) |\n| `irc.realname` | Real name on on the IRC server | |\n| `irc.channel` | IRC channel to join and listen for incoming commands. | `irc.nickname` (above) |\n| `commands.filename` |  Path of the file that holds the IRC commands to listen | commands.json |\n| `commands.watch` | Reload the commands file when it has changed on disk | False |\n| `commands.watch_interval` | Time (in seconds) between checking for file changes | 60 |\n| `output.osc.ip` | IP Address of the OSC target | 127.0.0.1 |\n| `output.osc.post` | Port of the OSC target | None (**Required** if `OSC` is used) |\n| `output.http.base_url` | URL target to post to | None (**Required** if `HTTP` is used) |\n| `output.http.jwt_secret` | JWT secret for using JWT encoding | |\n\n## Commands File Options\n\n| Key | Description | Default |\n| --- | ----------- | ------- |\n| `min` | Mininum possible value for this command | 0.0 |\n| `max` | Maximum possible value for this command | 1.0 |\n| `delta` | Amount to change whenever an INCREMENT or DECREMENT command is received | 0.05 |\n| `initial` | Initial value for this command | 0.5 |\n| `outputs.osc.address` | OSC Address to which the message should be send | |\n| `outputs.http.command_new` | Key to used for the POSTed HTTP data | |\n| `outputs.http.endpoint` | Endpoint to POST to for this command | |\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/MattBroach/chat_transformer",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "chat-transformer",
        "package_url": "https://pypi.org/project/chat-transformer/",
        "platform": "",
        "project_url": "https://pypi.org/project/chat-transformer/",
        "project_urls": {
            "Homepage": "https://github.com/MattBroach/chat_transformer"
        },
        "release_url": "https://pypi.org/project/chat-transformer/0.5.0/",
        "requires_dist": [
            "irc (>=16.4)",
            "python-osc (>=1.6.6)",
            "aiohttp (>=3.3.2)",
            "PyJWT (==1.6.4)"
        ],
        "requires_python": ">=3.5.3",
        "summary": "Bridge that takes incoming IRC messages and converts them to other formats",
        "version": "0.5.0"
    },
    "last_serial": 4348561,
    "releases": {
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1fdee7158d0fe35e00ac21f74508868a",
                    "sha256": "aa04b77da6ba41d67d0206f4230924d46c281922958d63c780d683131f663f1a"
                },
                "downloads": -1,
                "filename": "chat_transformer-0.3.0-py3.6.egg",
                "has_sig": false,
                "md5_digest": "1fdee7158d0fe35e00ac21f74508868a",
                "packagetype": "bdist_egg",
                "python_version": "3.6",
                "requires_python": ">=3.5.3",
                "size": 47287,
                "upload_time": "2018-09-19T05:00:04",
                "url": "https://files.pythonhosted.org/packages/ba/2d/16c2f0ba00260e3369afe66430a0f43e7dd0b8c50624c62c04cffef8d6ce/chat_transformer-0.3.0-py3.6.egg"
            }
        ],
        "0.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6dfff8115b75a390e93674d7ce1e0066",
                    "sha256": "1bd12bc168bd1a45121e47fc4b2e224e25fdbb61fe5459bbaaa81cd5d931c6d3"
                },
                "downloads": -1,
                "filename": "chat_transformer-0.4.0-py3.6.egg",
                "has_sig": false,
                "md5_digest": "6dfff8115b75a390e93674d7ce1e0066",
                "packagetype": "bdist_egg",
                "python_version": "3.6",
                "requires_python": ">=3.5.3",
                "size": 65417,
                "upload_time": "2018-09-19T05:00:05",
                "url": "https://files.pythonhosted.org/packages/18/1e/4b4915beffedc7c1275e2c032a71e91ef76f236580a7821adeb9f7159dad/chat_transformer-0.4.0-py3.6.egg"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "c2a2482f133c257592c79ffa362dbbca",
                    "sha256": "41c256297768beb90b0abdd60e57e5221b20eea3b9c3f3fb6bf20f68960a177a"
                },
                "downloads": -1,
                "filename": "chat_transformer-0.4.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c2a2482f133c257592c79ffa362dbbca",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5.3",
                "size": 28173,
                "upload_time": "2018-09-19T05:00:02",
                "url": "https://files.pythonhosted.org/packages/66/0a/4db42ae63c26c6dcd0d4f36fad8bff4ebd1d8fdfb75501a42fcb66f6ecba/chat_transformer-0.4.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "97ad10db2f1f51b00c758fcade40e408",
                    "sha256": "3f7940c6301d0413abc00e69f86986d70a49d06b612e7b47b9e1f79698b45099"
                },
                "downloads": -1,
                "filename": "chat_transformer-0.4.0.tar.gz",
                "has_sig": false,
                "md5_digest": "97ad10db2f1f51b00c758fcade40e408",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5.3",
                "size": 14364,
                "upload_time": "2018-09-19T05:00:06",
                "url": "https://files.pythonhosted.org/packages/d1/00/142754ffbbc2cf3e40b61f95ff50c43728f3528042e97d2316fe6ba2cd85/chat_transformer-0.4.0.tar.gz"
            }
        ],
        "0.5.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ac49129adf97627b84f63475105c4135",
                    "sha256": "a3c4dbd15cfbe80e516e1c6baf998ff2b408bf1f327a24ec6b0eb0064526e816"
                },
                "downloads": -1,
                "filename": "chat_transformer-0.5.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ac49129adf97627b84f63475105c4135",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5.3",
                "size": 19363,
                "upload_time": "2018-10-07T04:19:50",
                "url": "https://files.pythonhosted.org/packages/32/d3/867067148bbe9979e820db67a8bfcb82e4811cc72a705b3bac132646ece6/chat_transformer-0.5.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "56a0f13b7fcf71b5ac6e1ce580001e23",
                    "sha256": "e04c6643bcf2d6fdd652c5fd9d95703957a71d055916860300d5b180ea50b158"
                },
                "downloads": -1,
                "filename": "chat_transformer-0.5.0.tar.gz",
                "has_sig": false,
                "md5_digest": "56a0f13b7fcf71b5ac6e1ce580001e23",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5.3",
                "size": 14596,
                "upload_time": "2018-10-07T04:19:53",
                "url": "https://files.pythonhosted.org/packages/f3/7f/63a26b5efab6474404d1656cdb5a5bdd5d7685d29991dc8d5856ea415c6e/chat_transformer-0.5.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ac49129adf97627b84f63475105c4135",
                "sha256": "a3c4dbd15cfbe80e516e1c6baf998ff2b408bf1f327a24ec6b0eb0064526e816"
            },
            "downloads": -1,
            "filename": "chat_transformer-0.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ac49129adf97627b84f63475105c4135",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5.3",
            "size": 19363,
            "upload_time": "2018-10-07T04:19:50",
            "url": "https://files.pythonhosted.org/packages/32/d3/867067148bbe9979e820db67a8bfcb82e4811cc72a705b3bac132646ece6/chat_transformer-0.5.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "56a0f13b7fcf71b5ac6e1ce580001e23",
                "sha256": "e04c6643bcf2d6fdd652c5fd9d95703957a71d055916860300d5b180ea50b158"
            },
            "downloads": -1,
            "filename": "chat_transformer-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "56a0f13b7fcf71b5ac6e1ce580001e23",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5.3",
            "size": 14596,
            "upload_time": "2018-10-07T04:19:53",
            "url": "https://files.pythonhosted.org/packages/f3/7f/63a26b5efab6474404d1656cdb5a5bdd5d7685d29991dc8d5856ea415c6e/chat_transformer-0.5.0.tar.gz"
        }
    ]
}