{ "info": { "author": "Valentin 'esc' Haenel - Franck Roudet", "author_email": "UNKNOWN", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: MIT License", "Topic :: Utilities" ], "description": "=====================================\npykarotz - Python interface to Karotz\n=====================================\n\nAbout\n-----\n\nA (work-in-progress) Python library which provides object-oriented access to\nthe REST-API for `Karotz`_::\n\n _ _ ________________________________\n / \\ / \\ / \\\n \\ \\ / / | https://github.com/esc/pykarotz |\n \\ \\ / / \\____ ___________________________/\n \\ \\___/ / /_/\n _ / \\ _\n _ __ _ _| | ___|__ O __O___|| |_ ____\n | '_ \\| | | | |/ / _` | '__/ _ \\| __|_ /\n | |_) | |_| | < (_| | | | (_) | |_ / /\n | .__/ \\__, |_|\\_\\__,_|_| \\___/ \\__/___|\n |_| |___/ | |\n \\_________/\n\n.. _`Karotz`: http://www.karotz.com/home\n\nDependencies\n------------\n\n* `lxml `_\n\nInstallation\n------------\n\nPlace the ``karotz.py`` file where you want to use it.\negg in progress\n\nGetting Started\n---------------\n\nFirst, you must register an interactive application and install this on the\ntarget Karotz. For now, you can find some great instructions on the `Ruby API\nblog-post `_.\n\nAfter doing this, you will have the access credentials ``INSTALL_ID``,\n``API_KEY`` and a ``SECRET``. You have several ways to use these with\n``pykarotz``. The easiest is to place the configuration in a configuration file\n(standard INI format) in your home directory ``$HOME/.pykarotz``, for example::\n\n [karotz-app-settings]\n apikey = 23426660-beef-beee-baad-food0000babe\n secret = 23426660-beef-beee-baad-food0000babe\n installid = 23426660-beef-beee-baad-food0000babe\n\nIf you have done everything correctly, you can establish a connection and demo\nthe available colors from an interactive Python prompt using::\n\n >>> import karotz as kz\n >>> krtz = kz.Karotz()\n >>> krtz.led.demo()\n >>> krtz.stop()\n\nIn case you have placed the file somewhere else, for example if you are using\nWindows and have placed the file at ``C:\\pykarotz.txt``, you can initialise the\n``Karotz`` class using::\n\n >>> import karotz as kz\n >>> settings = kz.parse_config(config_filename=\"C:\\pykarotz.txt\")\n >>> krtz = kz.Karotz(settings=settings)\n\nIf instead, you want to hardcode the settings in your Python source file, you\ncan do something like::\n\n >>> import karotz as kz\n >>> settings['apikey'] = \"23426660-beef-beee-baad-food0000babe\"\n >>> settings['installid'] = \"23426660-beef-beee-baad-food0000babe\"\n >>> settings['secret'] = \"23426660-beef-beee-baad-food0000babe\"\n >>> krtz = kz.Karotz(settings=settings)\n\nIf you have multiple units, you can save their settings in different sections::\n\n [karotz-one]\n apikey = 23426660-beef-beee-baad-food0000babe\n secret = 23426660-beef-beee-baad-food0000babe\n installid = 23426660-beef-beee-baad-food0000babe\n [karotz-two]\n apikey = 23426660-beef-beee-baad-food0000babe\n secret = 23426660-beef-beee-baad-food0000babe\n installid = 23426660-beef-beee-baad-food0000babe\n\nAnd then use the keyword argument `section` to load them::\n\n >>> import karotz as kz\n >>> krtz1 = kz.Karotz(kz.parse_config(section='karotz-one'))\n >>> krtz2 = kz.Karotz(kz.parse_config(section='karotz-two'))\n\nAPI\n---\n\nCurrently the following REST API calls are supported:\n\n* Ears\n* Led\n* TTS\n* Config\n* Mutimedia\n* Video\n\nYou can access them in an object oriented fashion using ``kz.ears``, ``kz.led``\nand ``kz.tts``::\n\n >>> import karotz as kz\n >>> krtz = kz.Karotz()\n >>> krtz.ears.sad()\n >>> krtz.led.light(kz.PURPLE)\n >>> krtz.tts.speak('Why is the world so evil?')\n >>> krtz.stop()\n\nExamples\n--------\n\nSee the directory ``examples`` for some example applications.:\n\n* ``examples/kznotify``: Command line notification\n (`Direct link via GitHub `_)\n\n* ``examples/kzambient``: Ambient light source\n (`Direct link via GitHub `_ )\n\nTesting\n-------\n\nInstall `nose `_ and then do::\n\n $ nosetests\n\nSimilar Projects\n----------------\n\n* `Ruby `_\n* `Php `_\n\nLinks\n-----\n\n* `Developer Pages (APIs etc..) `_\n* `Google group 'KarotzDev' `_\n* `Karotz Wiki `_\n\n\nAuthor, Copyright and License\n-----------------------------\n\n| (C) 2012 Valentin 'esc' Haenel ``, Franck Roudet\n\npykarotz is licensed under the terms of the MIT License.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do\nso, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "UNKNOWN", "keywords": null, "license": "MIT License", "maintainer": null, "maintainer_email": null, "name": "pykarotz", "package_url": "https://pypi.org/project/pykarotz/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/pykarotz/", "project_urls": { "Download": "UNKNOWN", "Homepage": "UNKNOWN" }, "release_url": "https://pypi.org/project/pykarotz/0.2/", "requires_dist": null, "requires_python": null, "summary": "karotz python API", "version": "0.2" }, "last_serial": 915679, "releases": { "0.2": [ { "comment_text": "", "digests": { "md5": "7c352bc64377d35ceb28133bdfff50f2", "sha256": "18b53788c50483b7f9e2966d0cf7c495a4236e06b9ca491847428e16476273fb" }, "downloads": -1, "filename": "pykarotz-0.2.tar.gz", "has_sig": false, "md5_digest": "7c352bc64377d35ceb28133bdfff50f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8774, "upload_time": "2013-02-23T15:17:22", "url": "https://files.pythonhosted.org/packages/41/74/a0bcf23323f0a4e5eb80bfcbbe74861375d0ceee311946cdbca4a5ca2871/pykarotz-0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7c352bc64377d35ceb28133bdfff50f2", "sha256": "18b53788c50483b7f9e2966d0cf7c495a4236e06b9ca491847428e16476273fb" }, "downloads": -1, "filename": "pykarotz-0.2.tar.gz", "has_sig": false, "md5_digest": "7c352bc64377d35ceb28133bdfff50f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8774, "upload_time": "2013-02-23T15:17:22", "url": "https://files.pythonhosted.org/packages/41/74/a0bcf23323f0a4e5eb80bfcbbe74861375d0ceee311946cdbca4a5ca2871/pykarotz-0.2.tar.gz" } ] }