{ "info": { "author": "Billy Wildi", "author_email": "bwildi94@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# unityrde\nunityrde (Unity raw data export) is a Python 3 package for pulling raw data from the Unity Analytics REST API. See the [Unity documentation](https://docs.unity3d.com/Manual/UnityAnalyticsRawDataExport.html) for more information on how this works.\n\n## Installation\n\n```python\npython -m pip install unityrde\n```\n\n## Quickstart guide\nFirstly, create a UnityDataImporter object and include your Unity project id and your API key:\n\n```python\nfrom unityrde import *\n\nupid = \"aa43ae0a-a7a7-4016-ae96-e253bb126aa8\"\nkey = \"166291ff148b2878375a8e54aebb1549\"\nudi = UnityDataImporter(upid, key)\n```\n\nTo pull data from the API you need to first either create a new data export, or use a data export that has been created previously. For the latter case, you need to get the export_id. The list_data_exports method can be used to identify previously created data exports:\n\n```python\n# Get a json of the metadata of all data exports\nexports = udi.list_data_exports()\n\n# get the id of the most recent export\nexport_id = exports[0]['id']\n```\n\nYou can then use the get_data_export method to get a json of the data from this export:\n\n```python\ndata = udi.get_data_export(export_id)\n```\n\nIf you need to create a new export, you can run create_export. Make sure when setting the parameters that you include a startDate, endDate and dataset. For help on parameters, see the [Unity documentation](https://docs.unity3d.com/Manual/UnityAnalyticsRawDataExport.html).\n\n```python\nparams = {\n 'startDate': '2019-09-01',\n 'endDate': '2019-09-30',\n 'dataset': 'appStart'\n}\n\nudi.create_export(params)\n```\n\nThis will create a new export_id, which is associated with the class through the export_id attribute. The export will usually take a minute or two to be created. You can check its status by looking at the export metadata:\n\n```python\nprint(udi.get_data_export(output='metadata')['status'])\n```\nNote that it was not necessary to specify the export_id this time. Once the status is completed, you can get a json of the data:\n\n```python\ndata = udi.get_data_export()\n```\n\nAlternatively, you can do all this in one step using the create_and_get_export method:\n\n```python\ndata = udi.create_and_get_export(params)\n```\n\n## pandas and longer exports\nFor convenience, there are a couple of methods in the package that allow you to output pandas dataframes. Firstly, any json data file you produce from the previous step can be converted using the convert_to_pandas function\n\n```python\ndf = convert_to_pandas(data)\n```\n\nSecondly, the make_long_df method can be used to export more than 31 days of data at once. It does this by creating multiple exports and appending them together into a single pandas DataFrame.\n\n```python\nparams['startDate'] = '2019-08-01'\nparams['endDate'] = '2019-10-14'\ndf = udi.make_long_df(params)\n```\n\n## Maintenance\n\nI made this package in a professional context. I am no longer able to test the functionality of the package, because I do not have access to a Unity Analytics account. I will fix obvious errors where I can, but if the Unity API changes in such a way that breaks this package, I will not be able to repair it.\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/bwildi/unityrde/tree/master/unityrde", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "unityrde", "package_url": "https://pypi.org/project/unityrde/", "platform": "", "project_url": "https://pypi.org/project/unityrde/", "project_urls": { "Homepage": "https://github.com/bwildi/unityrde/tree/master/unityrde" }, "release_url": "https://pypi.org/project/unityrde/0.0.6/", "requires_dist": null, "requires_python": ">=3.5", "summary": "A Python package for the Unity Analytics Raw Data Export REST API", "version": "0.0.6" }, "last_serial": 5972728, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "3fcb97a48114b97c818b4f95ee34edb4", "sha256": "a1274fba611591960a8033513e80b9f6ca4f0e2f5402746d9d1a737195799bcf" }, "downloads": -1, "filename": "unityrde-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "3fcb97a48114b97c818b4f95ee34edb4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 7599, "upload_time": "2019-10-14T17:30:48", "url": "https://files.pythonhosted.org/packages/21/5e/f9e14e9a9f624cbffd0b66af85fd5a87efc596377a28852930b6931a8d5a/unityrde-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e46c330fd6d66baf442196f405509bc3", "sha256": "14c632ff91a7ce639e5440dc3743a69562a1b1d149b3f9da3787147c91f05759" }, "downloads": -1, "filename": "unityrde-0.0.1.tar.gz", "has_sig": false, "md5_digest": "e46c330fd6d66baf442196f405509bc3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5892, "upload_time": "2019-10-14T17:30:50", "url": "https://files.pythonhosted.org/packages/3c/bf/f896e5e3759b47c4b6344cc3f2cc7ddd6990563691ae8aa217d7b5b14313/unityrde-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "4f612be86811e9f1b1353a211bfe9ddf", "sha256": "094c34aa40e5925e2211e4419fce4590a2e3caec8ca840f2c4647909b71eac24" }, "downloads": -1, "filename": "unityrde-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "4f612be86811e9f1b1353a211bfe9ddf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 6842, "upload_time": "2019-10-14T17:49:03", "url": "https://files.pythonhosted.org/packages/34/94/a877a05e6647f50d453c8f39a9ad3db9b8899e93c24dbefe24a0945a4a42/unityrde-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4619f71f799aaf3b1e8549e631c7a6cd", "sha256": "af62b3d89a21bbda39c917d65f39ca2ae6f2d21e4972532abce2decfb2899b4d" }, "downloads": -1, "filename": "unityrde-0.0.2.tar.gz", "has_sig": false, "md5_digest": "4619f71f799aaf3b1e8549e631c7a6cd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5930, "upload_time": "2019-10-14T17:49:05", "url": "https://files.pythonhosted.org/packages/99/3c/aea997f764ee8a01cca998de087ca6222d9cac740f6d3f45fe20e6505786/unityrde-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "ace9b0f9aec761693253722e10b21a88", "sha256": "282125e6e982e40db2fea143b911a595c5b6ddd107d7f6477f769279ef88f523" }, "downloads": -1, "filename": "unityrde-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "ace9b0f9aec761693253722e10b21a88", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 7658, "upload_time": "2019-10-14T17:55:51", "url": "https://files.pythonhosted.org/packages/8f/04/c083e2e90104e38a4f60811c8fef140bf92862e3730d28ed451240712d3a/unityrde-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "83c01c044f794304eb635a6349a594c6", "sha256": "d68a35b0f4d71f50412deacd824c3350ec0f9084bbdeb76441339852a46068d7" }, "downloads": -1, "filename": "unityrde-0.0.3.tar.gz", "has_sig": false, "md5_digest": "83c01c044f794304eb635a6349a594c6", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5930, "upload_time": "2019-10-14T17:55:52", "url": "https://files.pythonhosted.org/packages/e2/66/d55c7dd4d040ff17cdaf1ba4c711950bc194b3b3e1c32eed4608ca5b6c8b/unityrde-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "cc1c4e5dcfb3f44c5beb37e28f45bfbe", "sha256": "d663070b83b4c350f392cb3039da38103f231d4295bca5fc7f114179ceeef5a4" }, "downloads": -1, "filename": "unityrde-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "cc1c4e5dcfb3f44c5beb37e28f45bfbe", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 7708, "upload_time": "2019-10-14T18:05:02", "url": "https://files.pythonhosted.org/packages/ad/a9/5ef391ee9c0193b4b63800683bc2d33b7703e008537bb5a7903a6c67781a/unityrde-0.0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cd66b4f5be68eb1c2acdf831485ae11f", "sha256": "811890c4221d6f2ecb7b5dcef54fff2d2b66c190925f406c1645cc8059904514" }, "downloads": -1, "filename": "unityrde-0.0.4.tar.gz", "has_sig": false, "md5_digest": "cd66b4f5be68eb1c2acdf831485ae11f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5941, "upload_time": "2019-10-14T18:05:04", "url": "https://files.pythonhosted.org/packages/8e/6a/813d3f4f12bef35ff1ea78e30c58807aa06d161a1917bc691642e8df6db8/unityrde-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "8ba5c07348ad8cb4a24f0cd937aedab0", "sha256": "fc075f4c962c48c0b5e08c3cb49c00a54fe129e86e08ef13363f9bb327f929c7" }, "downloads": -1, "filename": "unityrde-0.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "8ba5c07348ad8cb4a24f0cd937aedab0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 7710, "upload_time": "2019-10-14T18:10:26", "url": "https://files.pythonhosted.org/packages/d6/a8/1a3fb649c652415e9a223ddf5d457e0b92ea443df18c589548f4a63b2234/unityrde-0.0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e905369194257c359edc8597e8252f59", "sha256": "fa980b09906319b03b6801adc5fed218d60f6b8437db19703e5dd30c784c2776" }, "downloads": -1, "filename": "unityrde-0.0.5.tar.gz", "has_sig": false, "md5_digest": "e905369194257c359edc8597e8252f59", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5949, "upload_time": "2019-10-14T18:10:28", "url": "https://files.pythonhosted.org/packages/ce/9f/e57debd3f847a8855144ed2ff7f8a1f6ea66075296d795bfb04c1ecd9724/unityrde-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "ac5aa5b373abf4cb671b419687075be4", "sha256": "6743bb28de79ad06db92024f1de071a858deb2d20a1df7959714693b58a7dd31" }, "downloads": -1, "filename": "unityrde-0.0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "ac5aa5b373abf4cb671b419687075be4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 7697, "upload_time": "2019-10-14T18:26:22", "url": "https://files.pythonhosted.org/packages/5f/e8/faef7e6ca6b46a8c78f3555f35cbf3602beb5c25f09e5d4ee0afe9039e0f/unityrde-0.0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fa9cd884e45fdfcc60cfcedaf8609b3f", "sha256": "cca23727476213d086cb169898ea5c8e96e1be5f0de04f19c74b09e75da86c3b" }, "downloads": -1, "filename": "unityrde-0.0.6.tar.gz", "has_sig": false, "md5_digest": "fa9cd884e45fdfcc60cfcedaf8609b3f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5934, "upload_time": "2019-10-14T18:26:24", "url": "https://files.pythonhosted.org/packages/a8/81/21d90e4c9cf1331771b235b6d6d89b837f09d09785b16859f85e86c2a479/unityrde-0.0.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ac5aa5b373abf4cb671b419687075be4", "sha256": "6743bb28de79ad06db92024f1de071a858deb2d20a1df7959714693b58a7dd31" }, "downloads": -1, "filename": "unityrde-0.0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "ac5aa5b373abf4cb671b419687075be4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 7697, "upload_time": "2019-10-14T18:26:22", "url": "https://files.pythonhosted.org/packages/5f/e8/faef7e6ca6b46a8c78f3555f35cbf3602beb5c25f09e5d4ee0afe9039e0f/unityrde-0.0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fa9cd884e45fdfcc60cfcedaf8609b3f", "sha256": "cca23727476213d086cb169898ea5c8e96e1be5f0de04f19c74b09e75da86c3b" }, "downloads": -1, "filename": "unityrde-0.0.6.tar.gz", "has_sig": false, "md5_digest": "fa9cd884e45fdfcc60cfcedaf8609b3f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5934, "upload_time": "2019-10-14T18:26:24", "url": "https://files.pythonhosted.org/packages/a8/81/21d90e4c9cf1331771b235b6d6d89b837f09d09785b16859f85e86c2a479/unityrde-0.0.6.tar.gz" } ] }