{ "info": { "author": "Alexander Kavanaugh", "author_email": "alex@kavdev.io", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3 :: Only" ], "description": "=============================\npython-xirsys\n=============================\nA Python 3 interface to the XirSys API\n\nBadges\n------\n\n.. image:: https://img.shields.io/travis/kavdev/python-xirsys/master.svg?style=flat-square\n :target: https://travis-ci.org/kavdev/python-xirsys\n.. image:: https://img.shields.io/codecov/c/github/kavdev/python-xirsys/master.svg?style=flat-square\n :target: http://codecov.io/github/kavdev/python-xirsys?branch=master\n.. image:: https://img.shields.io/requires/github/kavdev/python-xirsys.svg?style=flat-square\n :target: https://requires.io/github/kavdev/python-xirsys/requirements/?branch=master\n.. image:: https://img.shields.io/codacy/75dbe2685efe47c3aa203a53154c9e7e.svg?style=flat-square\n :target: https://www.codacy.com/app/kavanaugh-development/python-xirsys/dashboard\n\n.. image:: https://img.shields.io/pypi/v/python-xirsys.svg?style=flat-square\n :target: https://pypi.python.org/pypi/python-xirsys\n.. image:: https://img.shields.io/pypi/dw/python-xirsys.svg?style=flat-square\n :target: https://pypi.python.org/pypi/python-xirsys\n\n.. image:: https://img.shields.io/github/issues/kavdev/python-xirsys.svg?style=flat-square\n :target: https://github.com/kavdev/python-xirsys/issues\n.. image:: https://img.shields.io/github/license/kavdev/python-xirsys.svg?style=flat-square\n :target: https://github.com/kavdev/python-xirsys/blob/master/LICENSE\n\nUsage\n-----\n\nInstall python-xirsys:\n\n.. code-block:: bash\n\n pip install python-xirsys\n\nBuild a Connection object:\n\n.. code-block:: python\n\n from python_xirsys import Connection\n \n connection = Connection(username=\"\", secret_key=\"\"\n\nGrab XirSys signaling server:\n\n.. code-block:: python\n\n >>> SignalingServer.list_all(connection=connection)\n \n >>> server = SignalingServer.list_all(connection=connection)\n >>> server.address\n ''\n\nGenerate a XirSys WebSocket token:\n\n.. code-block:: python\n\n >>> from python_xirsys.objects import SignalingServer\n >>> SignalingServer.generate_token(connection=connection, domain=\"domain.com\", application=\"application\", room=\"room\", secure=True)\n ''\n\nGrab a list of XirSys ICE servers:\n\n.. code-block:: python\n\n >>> from python_xirsys.objects import ICEServer\n >>> ICEServer.list_all(connection=connection, domain=\"domain.com\", application=\"application\", room=\"room\", secure=True, timeout=30)\n [, ...]\n >>> ice_servers = ICEServer.list_all(connection=connection, domain=\"domain.com\", application=\"application\", room=\"room\", secure=True, timeout=30)\n >>> ice_server = ice_servers[0]\n >>> ice_server.url\n ''\n >>> ice_server.server_type\n 'stun'\n >>> ice_server.username\n None\n >>> ice_server.credential\n None\n >>> ice_server = ice_servers[1]\n >>> ice_server.url\n ''\n >>> ice_server.server_type\n 'turn'\n >>> ice_server.username\n ''\n >>> ice_server.credential\n ''\n\nManage XirSys domains:\n\n.. code-block:: python\n\n >>> from python_xirsys.objects import Domain\n >>> Domain.create(connection=connection, domain=\"test.com\")\n \n >>> Domain.list_all(connection=connection)\n [, ]\n >>> domains = Domain.list_all(connection=connection)\n >>> domain = domains[domains.index(\"test.com\")]\n >>> domain.applications\n [, ...]\n >>> domain.disable()\n\nManage XirSys applications:\n\n.. code-block:: python\n\n >>> from python_xirsys.objects import Application\n >>> domains = Domain.list_all(connection=connection)\n >>> domain = domains[domains.index(\"domain.com\")]\n >>> Application.create(connection=connection, domain=domain, application=\"test\")\n \n >>> Application.list_all(connection=connection, domain=domain)\n [, ]\n >>> Application.list_all(connection=connection, domain=\"domain.com\")\n [, ]\n >>> applications = Application.list_all(connection=connection, domain=domain)\n >>> application = applications[applications.index(\"test\")]\n >>> application.rooms\n [, ...]\n >>> application.disable()\n\nManage XirSys rooms:\n\n.. code-block:: python\n\n >>> from python_xirsys.objects import Room\n >>> Room.create(connection=connection, domain=\"domain.com\", application=\"default\", room=\"test_room\")\n \n >>> rooms = Room.list_all(connection=connection, domain=\"domain.com\", application=\"default\")\n [, ]\n >>> room = rooms[rooms.index(\"test_room\")]\n >>> application.room()\n\nRunning the Tests\n------------------\n\n.. code-block:: bash\n\n pip install -r requirements/test.txt\n ./runtests.py\n\n\n\n\n\nChanges\n=======\n\n0.1.1 (2016-05-30)\n----------------------\n\n* Object names are now coerced to strings when initialized to avoid a TypeError\n\n0.1.0 (2016-05-26)\n----------------------\n\n* Initial release", "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/kavdev/python-xirsys/", "keywords": "xirsys", "license": "License :: OSI Approved :: MIT License", "maintainer": null, "maintainer_email": null, "name": "python-xirsys", "package_url": "https://pypi.org/project/python-xirsys/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/python-xirsys/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/kavdev/python-xirsys/" }, "release_url": "https://pypi.org/project/python-xirsys/0.1.1/", "requires_dist": null, "requires_python": null, "summary": "A Python 3 interface to the XirSys API.", "version": "0.1.1" }, "last_serial": 4691717, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "ee37b173041467fc28e524d9235ca9cd", "sha256": "d6e5006fd5ab6e65f355b89bae97a705217944532679008bd31fe7c47be8001a" }, "downloads": -1, "filename": "python_xirsys-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ee37b173041467fc28e524d9235ca9cd", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 7750, "upload_time": "2016-05-27T06:10:24", "url": "https://files.pythonhosted.org/packages/30/bf/0962999088ffafd775ca7b6fb6e988780d48b35dc2605de6c0ad79d77548/python_xirsys-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e5b4702e8f127036fa550c0cb6c4c3cc", "sha256": "9a844cb1c8f943f3354bd23a56ad630987f64b46c329a3e4f3e9fff096e8c889" }, "downloads": -1, "filename": "python-xirsys-0.1.0.tar.gz", "has_sig": false, "md5_digest": "e5b4702e8f127036fa550c0cb6c4c3cc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7603, "upload_time": "2016-05-27T06:10:18", "url": "https://files.pythonhosted.org/packages/76/d4/0d11f7cd1cd6604d2452b333b8d58c7a88bd0211dbfbc4b7c37bf80a7f45/python-xirsys-0.1.0.tar.gz" } ], "0.1.0.dev0": [ { "comment_text": "", "digests": { "md5": "a6a3be2dd29efdaec3c513e5693acb1b", "sha256": "ed55c3c96f6b9aa1cb6106ccab68166e756010f88897072a986d237fbe62a812" }, "downloads": -1, "filename": "python_xirsys-0.1.0.dev0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a6a3be2dd29efdaec3c513e5693acb1b", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 7827, "upload_time": "2016-05-27T06:01:17", "url": "https://files.pythonhosted.org/packages/f2/34/25a9aaa7684d3aa541c8bb36ee774f8576d4f5f01208880c8632089cf51b/python_xirsys-0.1.0.dev0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cb41951c97ecb4635b516ad09530d2f1", "sha256": "dcb9f9456c61928de31d15d9be1512095da98b9ff0456dfccc4b2b7bb1e590f8" }, "downloads": -1, "filename": "python-xirsys-0.1.0.dev0.tar.gz", "has_sig": false, "md5_digest": "cb41951c97ecb4635b516ad09530d2f1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7617, "upload_time": "2016-05-27T06:01:11", "url": "https://files.pythonhosted.org/packages/c7/79/3ec17795698554a3a16af210d7013da91f9f4f72dee5fc39d43f5c4feda4/python-xirsys-0.1.0.dev0.tar.gz" } ], "0.1.0.post1": [ { "comment_text": "", "digests": { "md5": "401cd2851246e00066f9e03b30f2f4c3", "sha256": "71e7cdf0afb182fb4ce3678dfc02005ae30936f5f663ceafef263690cd2919be" }, "downloads": -1, "filename": "python_xirsys-0.1.0.post1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "401cd2851246e00066f9e03b30f2f4c3", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 7845, "upload_time": "2016-05-27T06:13:22", "url": "https://files.pythonhosted.org/packages/35/67/9b784f3a096efbc06e0be6d86e60261519ab5c4a9a271b3d0bf8602b292b/python_xirsys-0.1.0.post1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fda0edb1263e014232a6db11ecee511d", "sha256": "c7d19cc36ceb14dfc129124f97e7d1cfa88fe4241cb4bc0dc947e2bbbe13f0da" }, "downloads": -1, "filename": "python-xirsys-0.1.0.post1.tar.gz", "has_sig": false, "md5_digest": "fda0edb1263e014232a6db11ecee511d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7614, "upload_time": "2016-05-27T06:13:17", "url": "https://files.pythonhosted.org/packages/e3/b3/757edba3a169d799ce699009164456a8c7ed1c38cc8633bc80ce4baae578/python-xirsys-0.1.0.post1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "1dbdde8e2c32d37c3dcd7a637be0c17a", "sha256": "25392a1827b83473e115e9b344c0fe642f1db8a70b3f0ea1f08843644fecc2aa" }, "downloads": -1, "filename": "python_xirsys-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1dbdde8e2c32d37c3dcd7a637be0c17a", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 7867, "upload_time": "2016-05-30T19:30:28", "url": "https://files.pythonhosted.org/packages/fc/f1/5aa9b2af0973c94eebc152e07413a123b99fc32d97bbe2773a6e37f4b22f/python_xirsys-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5adf2354808142594f072cbfd9009d15", "sha256": "ba4998fdc4008a9148a4d94c49ae41188adbb877ac742593041171452ff2346a" }, "downloads": -1, "filename": "python-xirsys-0.1.1.tar.gz", "has_sig": false, "md5_digest": "5adf2354808142594f072cbfd9009d15", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7661, "upload_time": "2016-05-30T19:29:29", "url": "https://files.pythonhosted.org/packages/60/39/99736afdacda786deb0b4b7a4c629d68f1183915a134ba0ed53c26dbe87d/python-xirsys-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1dbdde8e2c32d37c3dcd7a637be0c17a", "sha256": "25392a1827b83473e115e9b344c0fe642f1db8a70b3f0ea1f08843644fecc2aa" }, "downloads": -1, "filename": "python_xirsys-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1dbdde8e2c32d37c3dcd7a637be0c17a", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 7867, "upload_time": "2016-05-30T19:30:28", "url": "https://files.pythonhosted.org/packages/fc/f1/5aa9b2af0973c94eebc152e07413a123b99fc32d97bbe2773a6e37f4b22f/python_xirsys-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5adf2354808142594f072cbfd9009d15", "sha256": "ba4998fdc4008a9148a4d94c49ae41188adbb877ac742593041171452ff2346a" }, "downloads": -1, "filename": "python-xirsys-0.1.1.tar.gz", "has_sig": false, "md5_digest": "5adf2354808142594f072cbfd9009d15", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7661, "upload_time": "2016-05-30T19:29:29", "url": "https://files.pythonhosted.org/packages/60/39/99736afdacda786deb0b4b7a4c629d68f1183915a134ba0ed53c26dbe87d/python-xirsys-0.1.1.tar.gz" } ] }