{ "info": { "author": "Riders Discount", "author_email": "opensource@ridersdiscount.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Communications :: Chat", "Topic :: Software Development :: Libraries", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "=======\nHypChat\n=======\nA Python package for HipChat's `v2 JSON REST API`_. It's based on v2's navigability and self-declaration.\n\n.. _v2 JSON REST API: https://www.hipchat.com/docs/apiv2\n\nInstallation\n============\nHypChat can either be installed from PyPI_:\n::\n\n\tpip install hypchat\n\nOr from source_:\n::\n\n\tpython setup.py install\n\n.. _PyPI: https://pypi.python.org/pypi/hypchat/\n.. _source: https://github.com/RidersDiscountCom/HypChat\n\nConcepts\n========\n\nThere are two basic types in HypChat: ``Linker`` and ``RestObject``. They are not meant to be instantiated directly but instead created as references from other objects.\n\nLinker\n------\nA simple callable that represents an unfollowed reference.\n\n``l.url``\n\tThe URL this object points to\n\n``l()``\n\tCalling a ``Linker`` will perform the request and return a ``RestObject``\n\nRestObject\n----------\nA subclass of ``dict``, contains additional functionality for links and actions.\n\nLinks\n~~~~~\nAs part of the v2 API, all objects have a ``links`` property with references to other objects. This is used to create ``Linker`` objects as attributes.\n\nFor example, all objects have a link called ``self``. This may be referenced as:\n::\n\n\tobj.self\n\nAnd the request performed by calling it:\n::\n\n\tobj.self()\n\n.. _expand:\n\nIf `Title Expansion`_ is desired, just past a list of things to be expanded as the ``expand`` keyword argument.\n\n.. _Title Expansion: https://www.hipchat.com/docs/apiv2/expansion\n\nOther Actions\n~~~~~~~~~~~~~\n\nMany of the v2 types define additional types, eg Rooms have methods for messaging, setting the topic, getting the history, and inviting users to the room. These are implemented as methods of subclasses. The complete listing is in the `Type List`_.\n\nTimezone Handling\n-----------------\nHypChat uses aware ``datetime`` objects throughout by the ``dateutil`` module. However, the HipChat API universally uses UTC.\n\nFor methods that take a ``datetime``, if a naive object is given, it will be assumed to be in UTC. If this is not what you mean, ``dateutil.tz`` has a wonderful selection of timezones_ available.\n\n.. _timezones: http://labix.org/python-dateutil#head-587bd3efc48f897f55c179abc520a34330ee0a62\n\nUsage\n=====\n\nFirst, create a HypChat object with the token\n\n::\n\n\thc = HypChat(\"mytoken\")\n\nIf you use Hipchat Server\n\n::\n\n\thc = HypChat(\"mytoken\", endpoint=\"https://hipchat.example.com\")\n\nThere are several root links:\n\n::\n\n\trooms = hc.rooms()\n\tusers = hc.users()\n\temots = hc.emoticons()\n\tcaps = hc.capabilities()\n\nIn addition, the HypChat object has methods for creating objects and directly referencing the basic types.\n\nFor example, you might do:\n\n::\n\n\tfor room in (r for r in hipchat.rooms(expand='items') if r['last_active'] < datetime.datetime(2013, 12, 1)):\n\t\troom.owner.message(\"Your room is dead; maybe archive it\")\n\nSince ``room.owner`` is a User stub, not just a generic object. (The Room objects are not stubs, since the ``expand`` keyword is used).\n\nDownloading history is as easy as:\n\n::\n\n\tlist(HypChat(token).get_room(id).history(datetime.datetime.utcnow()).contents())\n\nNote that this may eat up many requests for large rooms.\n\nNavigation\n----------\nAny time an object is referenced in a value (eg ``room['owner']``), a stub of that object is created, and the full object may be found with ``.self()``. Stubs contain the ID of the object, the name (if applicable), and any links that object has-including ``self``. This can be avoided by using the expand_ keyword.\n\nCollections-such as ``rooms``, ``users``, and ``emots`` above-all have an ``'items'`` key containing their list of things. In addition, the ``.contents()`` method will generate all of the items, handling pagination. As usual, object\n\nConsole\n-------\nIf you call ``python -m hypchat``, a interactive prompt (using IPython_ if available) will appear. The environment will contain ``hipchat``, an instance of the ``HypChat`` object. The token is pulled from ``~/.hypchat``, ``/etc/hypchat``, or the environment variable ``HIPCHAT_TOKEN``.\n\n.. _IPython: http://ipython.org/\n\nType List\n=========\n\nSee `TYPES.rst`_\n\n.. _TYPES.rst: https://github.com/RidersDiscountCom/HypChat/blob/master/TYPES.rst\n\nTODO List\n=========\n* API Links", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/RidersDiscountCom/HypChat", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "hypchat", "package_url": "https://pypi.org/project/hypchat/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/hypchat/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/RidersDiscountCom/HypChat" }, "release_url": "https://pypi.org/project/hypchat/0.21/", "requires_dist": null, "requires_python": null, "summary": "Package for HipChat's v2 API", "version": "0.21" }, "last_serial": 1899681, "releases": { "0.1": [ { "comment_text": "built for Linux-3.5.0-44-generic-x86_64-with-glibc2.7", "digests": { "md5": "d234dd12035e6527684b2ee97dcd49a0", "sha256": "c570a9e4e4fc73807b0a38410568b9e2892dc4dd044d56e7d996205e2a1badcf" }, "downloads": -1, "filename": "hypchat-0.1.linux-x86_64.tar.gz", "has_sig": false, "md5_digest": "d234dd12035e6527684b2ee97dcd49a0", "packagetype": "bdist_dumb", "python_version": "any", "requires_python": null, "size": 20617, "upload_time": "2013-12-12T19:30:43", "url": "https://files.pythonhosted.org/packages/b3/3d/077bc2a6ad21bb5fb5c0ea67646f4f6268284d1a80dd1b264499664dabce/hypchat-0.1.linux-x86_64.tar.gz" }, { "comment_text": "", "digests": { "md5": "7c54d392d36950cf3ee840d429bc33c9", "sha256": "7b6577c9582e4e2790eb3cee4aaabb3eda9e83eb467552a56df0fb8cbf6f8292" }, "downloads": -1, "filename": "hypchat-0.1.tar.gz", "has_sig": false, "md5_digest": "7c54d392d36950cf3ee840d429bc33c9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9834, "upload_time": "2013-12-12T19:31:12", "url": "https://files.pythonhosted.org/packages/10/d6/89407e4e140448ae5e8b5046f4893992fd4d6cf7c045fc2e043df9a6bf9b/hypchat-0.1.tar.gz" } ], "0.10": [ { "comment_text": "", "digests": { "md5": "19d9e8a2219ea5103cff4ac009cfba0c", "sha256": "c6259bb7e35219de484285a07fb4fb3fa5f0da18d2f4e1f078c3ccef575046e6" }, "downloads": -1, "filename": "hypchat-0.10.tar.gz", "has_sig": false, "md5_digest": "19d9e8a2219ea5103cff4ac009cfba0c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13323, "upload_time": "2013-12-27T16:11:28", "url": "https://files.pythonhosted.org/packages/0b/9e/1c4c763bdcc486c80d13aa997e827179c74664e53cff49da16ba6bcd77e8/hypchat-0.10.tar.gz" } ], "0.11": [ { "comment_text": "", "digests": { "md5": "9c5ddbe95e136a1d90b05f1e1b9c6840", "sha256": "1eced9dc94e06f7d8f21b48d52303e22fd5f2589c81fe20363aabde0f8df83fe" }, "downloads": -1, "filename": "hypchat-0.11.tar.gz", "has_sig": false, "md5_digest": "9c5ddbe95e136a1d90b05f1e1b9c6840", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13685, "upload_time": "2014-01-03T16:21:49", "url": "https://files.pythonhosted.org/packages/21/dc/89ce947d71f38b9bac47a4171944fab1f77533f969e1bd58598b84cb1e68/hypchat-0.11.tar.gz" } ], "0.12": [ { "comment_text": "", "digests": { "md5": "b146cdfa4ad304755e73251544b0a325", "sha256": "75246a36c81923e5947bbe9c58952745434510079542c4fcc993000f5ff3b28f" }, "downloads": -1, "filename": "hypchat-0.12.tar.gz", "has_sig": false, "md5_digest": "b146cdfa4ad304755e73251544b0a325", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13764, "upload_time": "2014-01-20T15:43:29", "url": "https://files.pythonhosted.org/packages/44/21/1cf115cbb508145ac557344651fb0b51314645a579754dd22f75668d89ca/hypchat-0.12.tar.gz" } ], "0.13": [ { "comment_text": "", "digests": { "md5": "c9168585239d1a43fd6830bb61daac77", "sha256": "0a7c25e911ced7eec76d2b539b08084b34dde12a15c9175f0abc524ca97b74fd" }, "downloads": -1, "filename": "hypchat-0.13.tar.gz", "has_sig": false, "md5_digest": "c9168585239d1a43fd6830bb61daac77", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15287, "upload_time": "2014-08-29T19:54:46", "url": "https://files.pythonhosted.org/packages/ec/30/844206a92af395bc42f2161585f1f8720963a1f19e807f667d9725fa0b4a/hypchat-0.13.tar.gz" } ], "0.14": [ { "comment_text": "", "digests": { "md5": "caf32099ca6b7e7ea1e86b5708992dbb", "sha256": "f59520a33397acb8857474947947d3fdd9dcf0ff29d42a2bcb838163db6009c0" }, "downloads": -1, "filename": "hypchat-0.14.tar.gz", "has_sig": false, "md5_digest": "caf32099ca6b7e7ea1e86b5708992dbb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15324, "upload_time": "2014-09-11T16:32:04", "url": "https://files.pythonhosted.org/packages/12/e3/4594d7113a6157e05aed9d5cb524ba9e70285e7d9ed012eff948acdbb77d/hypchat-0.14.tar.gz" } ], "0.15": [ { "comment_text": "", "digests": { "md5": "e8e098398410a3ebdbd2e2763deb93f5", "sha256": "b710d126ee6c1522cc10db3c56e8885c8839a12633ce49400f0c3a94ce4de38b" }, "downloads": -1, "filename": "hypchat-0.15.tar.gz", "has_sig": false, "md5_digest": "e8e098398410a3ebdbd2e2763deb93f5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15539, "upload_time": "2014-10-02T16:23:58", "url": "https://files.pythonhosted.org/packages/f0/8b/89caa267dd2ad6f648fe2b99083355ea773ccf51cb797f25287ef8600209/hypchat-0.15.tar.gz" } ], "0.16": [ { "comment_text": "", "digests": { "md5": "e5da46f062199983bce3cd3136f567f9", "sha256": "86a755c91c2b698eed6876f15e095452acf81603daccf3b3bd6c32d360dddae4" }, "downloads": -1, "filename": "hypchat-0.16.tar.gz", "has_sig": false, "md5_digest": "e5da46f062199983bce3cd3136f567f9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15600, "upload_time": "2014-10-24T19:56:09", "url": "https://files.pythonhosted.org/packages/cc/fc/47c15175caa7fcff803c49afd3002bf34bc44bcf805e10964e7bc81f008f/hypchat-0.16.tar.gz" } ], "0.17": [ { "comment_text": "", "digests": { "md5": "254c77aa0134cc0f49d690e84fce13e3", "sha256": "491fa064e7d0fcca80ca3face487e0312e6613e2e6c6592d28cbd5bf8d16ba86" }, "downloads": -1, "filename": "hypchat-0.17.tar.gz", "has_sig": false, "md5_digest": "254c77aa0134cc0f49d690e84fce13e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15721, "upload_time": "2014-12-15T17:36:47", "url": "https://files.pythonhosted.org/packages/66/7e/e2880efb4fca2786720ddf75beea0077a33a2f17ff380f28d98835e0afa6/hypchat-0.17.tar.gz" } ], "0.18": [ { "comment_text": "", "digests": { "md5": "df9143116105d0db5e1b72fc6f20badf", "sha256": "e756814dc2478fbd67eea228aab1e5fa60f4f75127c7024487d4d1dcef240715" }, "downloads": -1, "filename": "hypchat-0.18.tar.gz", "has_sig": false, "md5_digest": "df9143116105d0db5e1b72fc6f20badf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15857, "upload_time": "2014-12-19T14:28:21", "url": "https://files.pythonhosted.org/packages/cd/b1/e5d79038bff07fc70740408bfd9b768d7d11ad524883085e49e9061ced42/hypchat-0.18.tar.gz" } ], "0.19": [ { "comment_text": "", "digests": { "md5": "0eba09f7eec2274fe35467e76c6c4553", "sha256": "e92c608caaf96c045af4f111dfbbf5ad7f56b29cd669de259cefb32f94b5280e" }, "downloads": -1, "filename": "hypchat-0.19.tar.gz", "has_sig": false, "md5_digest": "0eba09f7eec2274fe35467e76c6c4553", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15994, "upload_time": "2015-08-19T02:02:20", "url": "https://files.pythonhosted.org/packages/11/1c/a3aec3eb97bb4e1ef691ab3f74b27d755f4f3e3b8054d14baecdb30b375d/hypchat-0.19.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "3db274d6410f772ceb094bc6ca6eaf0c", "sha256": "bfd9ab2f910d564765a15303a53b698713bbd3df3e6e7a6aa882376913dffff3" }, "downloads": -1, "filename": "hypchat-0.2.tar.gz", "has_sig": false, "md5_digest": "3db274d6410f772ceb094bc6ca6eaf0c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10192, "upload_time": "2013-12-12T22:12:29", "url": "https://files.pythonhosted.org/packages/8f/c6/8b04374d6276c4eb66b32e9a1530a3390ae5f9752e5b13462eeb67056cb2/hypchat-0.2.tar.gz" } ], "0.20": [ { "comment_text": "", "digests": { "md5": "5cd9ed8805ddf69cd8f6d8d3db6cc6ef", "sha256": "3a0821cb174cfd052e1b1a532b3229cd90793400007cbe0c3b69f2b2088b3f1c" }, "downloads": -1, "filename": "hypchat-0.20.tar.gz", "has_sig": false, "md5_digest": "5cd9ed8805ddf69cd8f6d8d3db6cc6ef", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16071, "upload_time": "2015-08-21T17:18:51", "url": "https://files.pythonhosted.org/packages/c7/63/47bb7ceab8df8487a46aca33f6094b1c8d8afe26f21cc769deebf311d33c/hypchat-0.20.tar.gz" } ], "0.21": [ { "comment_text": "", "digests": { "md5": "05df8c682be669f008a43bc79c94e820", "sha256": "ef37a9cd8103bb13ad772b28ba9223ca9d4278371e374450c3ea2918df70a8e9" }, "downloads": -1, "filename": "hypchat-0.21.tar.gz", "has_sig": false, "md5_digest": "05df8c682be669f008a43bc79c94e820", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16156, "upload_time": "2016-01-11T19:44:01", "url": "https://files.pythonhosted.org/packages/b6/56/e0a36bf88faf44eac567a0c785435c8ba73845e5259092bc51942543daf9/hypchat-0.21.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "f9c031bddbf2481d2103c980e7eeb19b", "sha256": "14839ee3dcaf10990f43b0fbb88555cbf484c92af4be31d0f699e44462e3349b" }, "downloads": -1, "filename": "hypchat-0.3.tar.gz", "has_sig": false, "md5_digest": "f9c031bddbf2481d2103c980e7eeb19b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10307, "upload_time": "2013-12-12T22:57:30", "url": "https://files.pythonhosted.org/packages/de/9d/285beee5b7b104d4bce5402c2feaa57013e092c193e0194eaadac8de369d/hypchat-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "04b7bc6bd92766259c8d70d05a413c6d", "sha256": "e3e25bf16e4a06f681e37dc6faa155b3ca91404aff556029ec589b17971e3e80" }, "downloads": -1, "filename": "hypchat-0.4.tar.gz", "has_sig": false, "md5_digest": "04b7bc6bd92766259c8d70d05a413c6d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10333, "upload_time": "2013-12-13T17:40:13", "url": "https://files.pythonhosted.org/packages/50/38/a7c85507da030e51ed06880428803db5521a53d5b99d3c266dbfad78a7ed/hypchat-0.4.tar.gz" } ], "0.5": [ { "comment_text": "", "digests": { "md5": "f0f04a5b3097460b6ff6940e476b7484", "sha256": "88e4758583785c4a713bb10fbb87306b6c64202df05c6a4df1a895266185635e" }, "downloads": -1, "filename": "hypchat-0.5.tar.gz", "has_sig": false, "md5_digest": "f0f04a5b3097460b6ff6940e476b7484", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12911, "upload_time": "2013-12-16T21:09:38", "url": "https://files.pythonhosted.org/packages/9b/62/f28b3ee9152ab63285285b6951d2f89e4b33b3bbf7f8dabdfbcd0d6c8310/hypchat-0.5.tar.gz" } ], "0.6": [ { "comment_text": "", "digests": { "md5": "f9794659bf14095b4b2fd06ab841cae4", "sha256": "1268b6b93fb57965cf8344e9f0d77849331b9b175217dc445b375399ae0da0d7" }, "downloads": -1, "filename": "hypchat-0.6.tar.gz", "has_sig": false, "md5_digest": "f9794659bf14095b4b2fd06ab841cae4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13293, "upload_time": "2013-12-18T21:50:43", "url": "https://files.pythonhosted.org/packages/42/cd/de8c3486a7f129ec7383ccc98d461f0bd0488ce5ae4f3a0a5d972b642359/hypchat-0.6.tar.gz" } ], "0.7": [ { "comment_text": "", "digests": { "md5": "263149a1ef19351537a1d9337b56fec0", "sha256": "d8300b0d227ea303c7ec19863cb28a4d1238a763c4b53e41363128bb308f9275" }, "downloads": -1, "filename": "hypchat-0.7.tar.gz", "has_sig": false, "md5_digest": "263149a1ef19351537a1d9337b56fec0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13272, "upload_time": "2013-12-18T22:12:04", "url": "https://files.pythonhosted.org/packages/5c/0b/8457502ec68061e42ea80bf868c9f22ed062b37b0973684e04e3f57ee45a/hypchat-0.7.tar.gz" } ], "0.8": [ { "comment_text": "", "digests": { "md5": "16e99393daebcf98f1ff3cb44186b8e5", "sha256": "55f94e6fb8e1df5aa02ddc33ad66a97eeb680f2201fe687a9c3afa92d8778f07" }, "downloads": -1, "filename": "hypchat-0.8.tar.gz", "has_sig": false, "md5_digest": "16e99393daebcf98f1ff3cb44186b8e5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13273, "upload_time": "2013-12-18T22:21:00", "url": "https://files.pythonhosted.org/packages/58/3c/2fb7137299c64ce19b951259e15833671169c54d4c1dafc07bc12c206438/hypchat-0.8.tar.gz" } ], "0.9": [ { "comment_text": "", "digests": { "md5": "b88d7c02b1ec2fb97f87f1c8c3e810bb", "sha256": "a25f941699d2876bd024f70b3ff4879a94507e5eecf8cb74958cd490a6eda2d1" }, "downloads": -1, "filename": "hypchat-0.9.tar.gz", "has_sig": false, "md5_digest": "b88d7c02b1ec2fb97f87f1c8c3e810bb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13289, "upload_time": "2013-12-23T19:50:38", "url": "https://files.pythonhosted.org/packages/92/13/6ebf9d8f38e3a0a179639b2d192117f223de0008690ca38b72e127c49ea5/hypchat-0.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "05df8c682be669f008a43bc79c94e820", "sha256": "ef37a9cd8103bb13ad772b28ba9223ca9d4278371e374450c3ea2918df70a8e9" }, "downloads": -1, "filename": "hypchat-0.21.tar.gz", "has_sig": false, "md5_digest": "05df8c682be669f008a43bc79c94e820", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16156, "upload_time": "2016-01-11T19:44:01", "url": "https://files.pythonhosted.org/packages/b6/56/e0a36bf88faf44eac567a0c785435c8ba73845e5259092bc51942543daf9/hypchat-0.21.tar.gz" } ] }