{
    "info": {
        "author": "Graham Preston",
        "author_email": "graham.preston@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.7"
        ],
        "description": "<img src=\"https://raw.githubusercontent.com/gcpreston/webcandy/master/webcandy/static/img/webcandy_logo.png\" alt=\"Webcandy\" width=\"500\" height=\"85\">\n\nAPI and web interface for Fadecandy control. For the client-side code\nresponsible for receiving requests from the Webcandy server and running lighting\nconfigurations on the Fadecandy itself, see\n[webcandy-client](https://github.com/gcpreston/webcandy-client).\n\n![](https://s3.gifyu.com/images/webcandy_demo1.gif)\n![](https://s3.gifyu.com/images/webcandy_demo2.gif)\n\n##  Requirements\n- [Python 3.7+](https://www.python.org/downloads/)\n- [Node.js + npm](https://nodejs.org/en/download/)\n\n## Setup\nTo install the necessary node modules, run:\n```\n$ cd webcandy/static\n$ npm install\n```\n\n### virtualenv\nIt is recommended to use a virtual Python environment. To set up virtualenv, run\nthe following:\n```\n$ pip install virtualenv\n$ virtualenv venv\n```\nThe virtual environment is now created. **To use it, it must be activated like\nso**:\n- Windows: `> .\\venv\\Scripts\\activate`\n- Mac/Linux: `$ source ./venv/bin/activate`\n\nThen, install the project requirements:\n```\n(venv) $ pip install -r requirements.txt\n```\n\n## Running\n### Dev environment\nIn a development environment, Webcandy should be run using Flask:\n```\n(venv) $ flask run\n```\n\nThen, in a different terminal:\n```\nwebcandy/webcandy/static $ npm run watch\n```\nThis will watch for front-end changes and automatically rebuild the JavaScript.\n\n* **Note**: If you don't see your changes in the browser, use `Ctrl/Cmd+Shift+R`\nto refresh and clear cache.\n\n### Server environment\nTo run Webcandy from a local server, activate the virtual environment and run\nthe server using `gunicorn`:\n```\n(venv) $ gunicorn 'webcandy:create_app()'\n```\n\nTo build the front-end code, run:\n```\nwebcandy/webcandy/static $ npm run build\n```\n\n### Clients\nTo control LEDs, you will need to connect a\n[client]((http://github.com/gcpreston/webcandy-client))\n([docs](https://webcandy.readthedocs.io/en/latest/client/quickstart.html)).\n\n```\n$ pip install webcandy-client\n$ wc-client RGBLover573 password123 MyClient\n```\n\n###  Login\nOn an independant server, if you want a user with some example data saved you\ncan log in as \"testuser1\" or \"testuser2\", each with password \"Webcandy1\".\n\n## Documentation\nDocumentation can be found at https://webcandy.readthedocs.io/. (WIP)\n\n## Acknowledgements\n* Thanks to Maksim Surguy ([msurguy](https://github.com/msurguy)) for the awesome logo!",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://webcandy.io",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "webcandy",
        "package_url": "https://pypi.org/project/webcandy/",
        "platform": "",
        "project_url": "https://pypi.org/project/webcandy/",
        "project_urls": {
            "Documentation": "https://webcandy.readthedocs.io",
            "Homepage": "https://webcandy.io",
            "Source": "https://github.com/gcpreston/webcandy"
        },
        "release_url": "https://pypi.org/project/webcandy/0.0.2/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "API and web interface for Fadecandy",
        "version": "0.0.2"
    },
    "last_serial": 5962364,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "19d87bc58c3d54495bb4b701a2755d28",
                    "sha256": "4754be48db5d08012d8075db7da6efe9f6797a12eff5043fea72cf6b5b5aa398"
                },
                "downloads": -1,
                "filename": "webcandy-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "19d87bc58c3d54495bb4b701a2755d28",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 1713064,
                "upload_time": "2019-09-04T23:57:20",
                "url": "https://files.pythonhosted.org/packages/9c/42/e269781385818465637d53766d2ccd9191f659a2f9f2f55cc5c73b20cd9a/webcandy-0.0.1.tar.gz"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "68f919f67a0e6a5e1a3d66d0cb3448e9",
                    "sha256": "c963254cad070b3a589f7bc5fd516068388af4a6fac4e34603245d8f140c5475"
                },
                "downloads": -1,
                "filename": "webcandy-0.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "68f919f67a0e6a5e1a3d66d0cb3448e9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13891,
                "upload_time": "2019-10-12T00:06:36",
                "url": "https://files.pythonhosted.org/packages/14/fe/745b98f342a996528682feb2db564220ca3880c8a8e3ca3fe9197877bcb1/webcandy-0.0.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "68f919f67a0e6a5e1a3d66d0cb3448e9",
                "sha256": "c963254cad070b3a589f7bc5fd516068388af4a6fac4e34603245d8f140c5475"
            },
            "downloads": -1,
            "filename": "webcandy-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "68f919f67a0e6a5e1a3d66d0cb3448e9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 13891,
            "upload_time": "2019-10-12T00:06:36",
            "url": "https://files.pythonhosted.org/packages/14/fe/745b98f342a996528682feb2db564220ca3880c8a8e3ca3fe9197877bcb1/webcandy-0.0.2.tar.gz"
        }
    ]
}