{ "info": { "author": "Ajedi32", "author_email": "ajedi32.web@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Topic :: Games/Entertainment" ], "description": "# Echo VR API\n\nPython bindings for Echo VR's HTTP API.\n\n## Installation\n\nIf you haven't already, [install Python 3](https://www.python.org/downloads/) and [Pipenv](https://pipenv.readthedocs.io/en/latest/install/).\n\nNow, in your project directory, run:\n\n```\npipenv install echovr-api\n```\n\n## Usage\n\nBasic usage example:\n\n```\nfrom requests.exceptions import ConnectionError\nimport json\nimport echovr_api\n\ntry:\n game_state = echovr_api.fetch_state()\n\n print(f\"Game status: {game_state.game_status}\")\n print(f\"Seconds on clock: {game_state.game_clock}\")\n\n if (game_state.blue_team.score > game_state.orange_team.score):\n print(\"Blue team is winning!\")\n elif (game_state.orange_team.score > game_state.blue_team.score):\n print(\"Orange team is winning!\")\n else:\n print(\"It's tied!\")\n\n print(f\"Score: {game_state.blue_team.score} - {game_state.orange_team.score}\")\n\nexcept ConnectionError as e:\n print(\"Connection refused. Make sure you're running Echo VR with the -http option and that you're in a match.\")\nexcept json.decoder.JSONDecodeError as e:\n print(\"Could not decode response. (Not valid JSON.)\")\n```\n\nFor comprehensive documentation of the available methods and classes, please see the [full API Documentation on Read The Docs](https://echovr-api.readthedocs.io/en/latest/).\n\n## Contributing\n\nTo get everything you need to start making changes to this package, first [install Python 3](https://www.python.org/downloads/) and [Pipenv](https://pipenv.readthedocs.io/en/latest/install/), clone this repository, then run:\n\n```\npipenv install\n```\n\n### Try it\n\nTo play around with the API, open an instance of Echo VR with the -http flag, then run:\n\n```\npipenv run python -i ./test.py\n```\n\n### Release process\n\nFirst, update `CHANGELOG.md` and the version number in `setup.py` and `docs/source/conf.py`. Then commit, tag, and push these changes.\n\nNext, build the package:\n\n```\npipenv install --dev\npipenv run python setup.py sdist bdist_wheel\n```\n\nFinally, upload the built packages to PyPi. You can do this using `twine`\n(`pip install twine`):\n\n```\ntwine upload dist/*\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Ajedi32/echovr-api/", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "echovr-api", "package_url": "https://pypi.org/project/echovr-api/", "platform": "", "project_url": "https://pypi.org/project/echovr-api/", "project_urls": { "Homepage": "https://github.com/Ajedi32/echovr-api/" }, "release_url": "https://pypi.org/project/echovr-api/0.2.0/", "requires_dist": [ "requests", "sphinx (<2.0.0a0,>=1.8.2); extra == 'docs'", "sphinx-autodoc-typehints (<2.0.0a0,>=1.5.0); extra == 'docs'", "sphinxcontrib-apidoc (<0.4.0a0,>=0.3.0); extra == 'docs'", "m2r (<0.3.0a0,>=0.2.1); extra == 'docs'", "sphinx-rtd-theme (<0.5.0a0,>=0.4.2); extra == 'docs'" ], "requires_python": "", "summary": "Python bindings for Echo VR's HTTP API.", "version": "0.2.0" }, "last_serial": 4501278, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "0d7461af96efe3e087fa98d24a720128", "sha256": "5a683dcdfd19c381d16498d29e629db81cc69f4df2d3441d419c7e58f08a1e17" }, "downloads": -1, "filename": "echovr_api-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "0d7461af96efe3e087fa98d24a720128", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6890, "upload_time": "2018-11-02T02:07:44", "url": "https://files.pythonhosted.org/packages/42/86/8dc7d95b462774ad043c370bd813282f13f3a7e82bc4c81f220a424554da/echovr_api-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4a8e4bf049767317f97c3a7d069008a6", "sha256": "776b999e2d44a7779eb304829f8f0cb5857648fa4ffdd2d4d95d59cce9d018fa" }, "downloads": -1, "filename": "echovr_api-0.0.1.tar.gz", "has_sig": false, "md5_digest": "4a8e4bf049767317f97c3a7d069008a6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3972, "upload_time": "2018-11-02T02:07:45", "url": "https://files.pythonhosted.org/packages/99/a7/da453a7c39397c3987981d2705fa3da197abe208112607f548a82ee64945/echovr_api-0.0.1.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "4b21440997bf96ac9db98fdf83a8ac6d", "sha256": "083445d7a7bee6eac526264da083a5f1c98eb8765e84e6022753762577639cd5" }, "downloads": -1, "filename": "echovr_api-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "4b21440997bf96ac9db98fdf83a8ac6d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7869, "upload_time": "2018-11-06T02:56:25", "url": "https://files.pythonhosted.org/packages/e9/dd/7f52eae0f8370b963c49ee7be1fe70de4e8c47f8a86551052ff7d57984c2/echovr_api-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4ddce73a21323619c7024bb93b8d070c", "sha256": "bc809d8807f0539d746883a846fbd5b0be2151eea24700f59630df11dca8df67" }, "downloads": -1, "filename": "echovr_api-0.1.0.tar.gz", "has_sig": false, "md5_digest": "4ddce73a21323619c7024bb93b8d070c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5052, "upload_time": "2018-11-06T02:56:26", "url": "https://files.pythonhosted.org/packages/6e/bf/11c18c63aa5f91f89cabe9000cd6e68fe43e798d9f6e7e0aaac667ff48e0/echovr_api-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "0e74f98ca40561e4ad1d71282b876931", "sha256": "6858b3df4c164b8be1824d396560e35e8bfa03f03843b8dcbd5bf187bace1140" }, "downloads": -1, "filename": "echovr_api-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "0e74f98ca40561e4ad1d71282b876931", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8052, "upload_time": "2018-11-07T01:02:09", "url": "https://files.pythonhosted.org/packages/0b/59/d89f4bc6ee6bad75f350609cdff939b4a7a6724d3e27eef4686c3a1679e4/echovr_api-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f54627f2296b1cdf200426f2ef0ac8a6", "sha256": "594921f8b9c64ed5e28d76ef6bfeccd6fa5adfd36f62f8ae8d0662f84207c007" }, "downloads": -1, "filename": "echovr_api-0.1.1.tar.gz", "has_sig": false, "md5_digest": "f54627f2296b1cdf200426f2ef0ac8a6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5309, "upload_time": "2018-11-07T01:02:10", "url": "https://files.pythonhosted.org/packages/03/36/1a596e8904f4eaeaaaccf91b55c4b86595b7a12150dc860d29f8c022d257/echovr_api-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "8178c3bb0bc0c8542a24b2e7da9a970c", "sha256": "4c3986ba5973be25f5e3c871f047bc32e95a4a60cd3333cf5540ccf7c0746c8f" }, "downloads": -1, "filename": "echovr_api-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8178c3bb0bc0c8542a24b2e7da9a970c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11753, "upload_time": "2018-11-19T02:46:46", "url": "https://files.pythonhosted.org/packages/47/79/901c7746742414c120562c4185dbe4df112b8f5385789b09f447c6e5137e/echovr_api-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d81c5337016f25ea71e46cfd1f7670b3", "sha256": "4a65e46d2a2d7788fe2bc3d5a05a18baebe078da554941e57cd07bc45336b44a" }, "downloads": -1, "filename": "echovr_api-0.2.0.tar.gz", "has_sig": false, "md5_digest": "d81c5337016f25ea71e46cfd1f7670b3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8998, "upload_time": "2018-11-19T02:46:48", "url": "https://files.pythonhosted.org/packages/98/a8/fab2721f0c24abfb3f3a33c93527b6ce5f51bfb40fbd1c306388e3fef726/echovr_api-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8178c3bb0bc0c8542a24b2e7da9a970c", "sha256": "4c3986ba5973be25f5e3c871f047bc32e95a4a60cd3333cf5540ccf7c0746c8f" }, "downloads": -1, "filename": "echovr_api-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8178c3bb0bc0c8542a24b2e7da9a970c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11753, "upload_time": "2018-11-19T02:46:46", "url": "https://files.pythonhosted.org/packages/47/79/901c7746742414c120562c4185dbe4df112b8f5385789b09f447c6e5137e/echovr_api-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d81c5337016f25ea71e46cfd1f7670b3", "sha256": "4a65e46d2a2d7788fe2bc3d5a05a18baebe078da554941e57cd07bc45336b44a" }, "downloads": -1, "filename": "echovr_api-0.2.0.tar.gz", "has_sig": false, "md5_digest": "d81c5337016f25ea71e46cfd1f7670b3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8998, "upload_time": "2018-11-19T02:46:48", "url": "https://files.pythonhosted.org/packages/98/a8/fab2721f0c24abfb3f3a33c93527b6ce5f51bfb40fbd1c306388e3fef726/echovr_api-0.2.0.tar.gz" } ] }