{
    "info": {
        "author": "Christian Hess",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# Shuup Channels\n\nEnables the power of WebSockets with [Django Channels](https://github.com/django/channels) in [Shuup Ecommerce Platform](https://github.com/shuup/shuup).\n\nThis project allows more advanced customizations and addons to be created with Shuup. By using websockets, a new set of solutions can be created and making user experience even better.\n\nTo use websocket on your Shuup projects, start by installing Shuup Channels ``pip install shuup-channels`` and add `shuup_channels` to your `INSTALLED_APPS` settings. Check [`workbench_project`](./workbench_project/app) for an example of project and configuration.\n\n## Usage\nThis project simply defines an ASGI applicaton with a websocket router which loads urls through Shuup Provides.\n\nAfter the installation, define a provide entry using the `channels_urls` key:\n\nin your `my_addon/apps.py`\n```\nclass AppConfig(shuup.apps.AppConfig):\n    provides = {\n        \"channels_urls\": [\n            \"my_addon.urls:channels_urls\"\n        ]\n    }\n```\n\nin your `my_addon/urls.py`\n```\nfrom django.conf.urls import url\nfrom my_addon.consumers import MyConsumer\nchannels_urls = [\n    url(r\"^ws/myaddon/$\", MyConsumer)\n]\n```\n\nDone, implement your `MyConsumer` following the Django Channels guidelines and you should be safe. The websocket url will be available as `ws://your-site-url/ws/myaddon/`.\n\n## Example of projects\n\n- [Shuup Admin Channel](https://github.com/chessbr/shuup-admin-channel) - Adds a generic and extendable channel to Admin module\n\n# Copyright\n\nCopyright (C) 2019 by Christian Hess\n\n# License\n\nMIT\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/chessbr/shuup-channels",
        "keywords": "shuup websocket channels",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "shuup-channels",
        "package_url": "https://pypi.org/project/shuup-channels/",
        "platform": "",
        "project_url": "https://pypi.org/project/shuup-channels/",
        "project_urls": {
            "Homepage": "https://github.com/chessbr/shuup-channels"
        },
        "release_url": "https://pypi.org/project/shuup-channels/1.0.1/",
        "requires_dist": [
            "shuup",
            "channels"
        ],
        "requires_python": "",
        "summary": "Enables the power of WebSockets with Django Channels in Shuup Ecommerce Platform.",
        "version": "1.0.1"
    },
    "last_serial": 5174923,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "20e2a6cc9cd4608b4e3c62e4a3656d0f",
                    "sha256": "d1ac24f58732d76979d55a7ca7ff0112c45ce9156437d33e0b3c74becedd66c7"
                },
                "downloads": -1,
                "filename": "shuup_channels-1.0.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "20e2a6cc9cd4608b4e3c62e4a3656d0f",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 3859,
                "upload_time": "2019-04-22T22:34:49",
                "url": "https://files.pythonhosted.org/packages/5c/7d/3adfb9f1e039c13a306c5120ec56acea11503055885d160c31eb5de85879/shuup_channels-1.0.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b03f944943c1d8ac55ffe158dfa4a1c5",
                    "sha256": "c15f90923ae354f992e4581e0efe4c4d7ce325470470003aa87782938decc4e6"
                },
                "downloads": -1,
                "filename": "shuup-channels-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "b03f944943c1d8ac55ffe158dfa4a1c5",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2502,
                "upload_time": "2019-04-22T22:34:51",
                "url": "https://files.pythonhosted.org/packages/fe/31/c4d6a9db69d150c48f3779a47e8bc3a3f9b98b09d02dcc6999e68439090d/shuup-channels-1.0.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "58483a89c684a9a5e677b43ce782f3d6",
                    "sha256": "ad118396f0e73a8408176c85301d2e1875aff1f8190ae940afd5e0518123ac09"
                },
                "downloads": -1,
                "filename": "shuup_channels-1.0.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "58483a89c684a9a5e677b43ce782f3d6",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 3036,
                "upload_time": "2019-04-22T23:07:46",
                "url": "https://files.pythonhosted.org/packages/43/ac/3c936c7de012edbeab6ffb4bef23b0d08a7835cf97f2445589498544c9eb/shuup_channels-1.0.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "4735a017a5be1f2936fa81a7cca2abd4",
                    "sha256": "62ada50590070ebab622e26e87572b828a13a097eaaf6de512f6afb7bea63dd7"
                },
                "downloads": -1,
                "filename": "shuup-channels-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "4735a017a5be1f2936fa81a7cca2abd4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2501,
                "upload_time": "2019-04-22T23:07:48",
                "url": "https://files.pythonhosted.org/packages/63/bb/d314580f3826ea25065cb35034a282849b10af82e2f399be98c85caa54f2/shuup-channels-1.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "58483a89c684a9a5e677b43ce782f3d6",
                "sha256": "ad118396f0e73a8408176c85301d2e1875aff1f8190ae940afd5e0518123ac09"
            },
            "downloads": -1,
            "filename": "shuup_channels-1.0.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "58483a89c684a9a5e677b43ce782f3d6",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 3036,
            "upload_time": "2019-04-22T23:07:46",
            "url": "https://files.pythonhosted.org/packages/43/ac/3c936c7de012edbeab6ffb4bef23b0d08a7835cf97f2445589498544c9eb/shuup_channels-1.0.1-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "4735a017a5be1f2936fa81a7cca2abd4",
                "sha256": "62ada50590070ebab622e26e87572b828a13a097eaaf6de512f6afb7bea63dd7"
            },
            "downloads": -1,
            "filename": "shuup-channels-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4735a017a5be1f2936fa81a7cca2abd4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2501,
            "upload_time": "2019-04-22T23:07:48",
            "url": "https://files.pythonhosted.org/packages/63/bb/d314580f3826ea25065cb35034a282849b10af82e2f399be98c85caa54f2/shuup-channels-1.0.1.tar.gz"
        }
    ]
}