{ "info": { "author": "Gameworks", "author_email": "gio@proudcloud.io", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# Gameworks Python SDK V1\n\n\nA Software Development Kit for serving Gameworks applications and services.\nThe SDK currently allows you to connect to the Gameworks Registry API.\n\n\n### Development Installation Instructions\n``` sh\n$ git clone https://github.com/gameworks-gwx/gameworks-python-sdk.git\n$ cd gameworks-python-sdk\n$ virtualenv venv\n...\n$ .venv/bin/activate\n$ pip install -r requirements.txt\n```\n\n### Generating Documentation\nSphinx is used for documentation. To generate the HTML output locally:\n``` sh\n$ pip install -r requirements-docs.txt\n$ cd docs\n$ sphinx-quickstart\n$ make html\n```\n\n### Installation\n\n``` sh\n$ pip install gameworksrestsdkdk\n```\n\n### Configuration and Session Creation\nCreate a Registry Session by importing the class from `gameworksrestsdk` and enter your credentials.\n\n```python\nfrom gameworksrestsdkdk import RegistrySession\n\nsession = RegistrySession(email='example@example.com', password='password')\n```\n\nBy default, the SDK endpoint is directed to the staging environment. In order to change the endpoint to production, set `mode='production'` as the paramters for the Api class constructor as seen in the code block below.\n\n```python\nfrom gameworksrestsdk import Api\n\napi = Api(mode='production')\nsession = RegistrySession(email='example@example.com', password='password', api=api)\n\n```\n### Retrieve Login Session Details\nAll call responses are encapsulated in a `RegistrySession` class. You may choose to access these responses as a `str` or a `dict`. \n\nRetrieve user details in dictionary form using the instantiated session class we created earlier.\n\n\n```python\nuser_details = session.session_details.to_dict()\n\n```\n\n\n### Create User Account\n```python\nsession.create_user(\n first_name='Luke', \n last_name='Skywalker',\n wallet_address='NBZMQO7ZPBYNBDUR7F75MAKA2S3DHDCIFG775N3D', \n pk='aaaaaaaaaaeeeeeeeeeebbbbbbbbbb5555555555dddddddddd1111111111aaee', \n email='luke@skywalker.com, \n password='nooooooooooo!!!!!!???!?!!!', \n password_confirmation='nooooooooooo!!!!!!???!?!!!'\n)\n```\n\n### Update User Account\n```python\nsession.update_user(\n user_id=1,\n first_name='Luke',\n last_name='Skywalker',\n pk='aaaaaaaaaaeeeeeeeeeebbbbbbbbbb5555555555dddddddddd1111111111aaee',\n wallet_address='NBZMQO7ZPBYNBDUR7F75MAKA2S3DHDCIFG775N3D'\n)\n```\n\n### Find User Account\n```python\nsession.find_user(user_id=1)\n```\n\n### Confirm User Account\n```python\nsession.confirm_user(confirmation_code='1111')\n```\n\n### Resend Code\n```python\nsession.resend_code(user_id=1)\n```\n\n### Create Player Profile\n```python\nsession.create_player(\n user_id=1, \n username='usetheforcelukeIV'\n)\n```\n\n### Update Player Profile\n```python\nsession.update_player(\n user_id=1, \n username='darthisnotmyfatherV'\n)\n```\n\n### Find Player Profile\n```python\nsession.find_player(user_id=1)\n```\n\n### Create Publisher Profile\n```python\nsession.create_publisher(\n user_id=1,\n publisher_name='Second Order',\n description='Definitely not the First',\n wallet_address='NBLSQO7ZPBYNBDU29TE5MAKA2S3DHDCIFG775N3D'\n)\n```\n\n### Update Publisher Profile\n```python\nsession.update_publisher(\n user_id=1,\n publisher_name='Second Order',\n description='Definitely not the First',\n wallet_address='NBLSQO7ZPBYNBDU29TE5MAKA2S3DHDCIFG775N3D'\n)\n```\n\n### Find Publisher Profile\n```python\nsession.find_publisher(user_id=1)\n```\n\n\n\n\n\n\n\n\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/gameworks-gwx/gameworks-python-sdk", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "gameworksrestsdk", "package_url": "https://pypi.org/project/gameworksrestsdk/", "platform": "", "project_url": "https://pypi.org/project/gameworksrestsdk/", "project_urls": { "Homepage": "https://github.com/gameworks-gwx/gameworks-python-sdk" }, "release_url": "https://pypi.org/project/gameworksrestsdk/1.1.0/", "requires_dist": [ "requests (==2.21.0)" ], "requires_python": "", "summary": "A Python Rest SDK for Gameworks Services", "version": "1.1.0" }, "last_serial": 4882342, "releases": { "1.0.1": [ { "comment_text": "", "digests": { "md5": "a90e3325a1925bb2509de192f3f8d3df", "sha256": "dc2ba85e85a1b89af32cf180f77688ad206ad3b65bcb9512d40e866764c9902b" }, "downloads": -1, "filename": "gameworksrestsdk-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "a90e3325a1925bb2509de192f3f8d3df", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15001, "upload_time": "2019-02-28T03:45:04", "url": "https://files.pythonhosted.org/packages/58/99/2e7e15a187bb94dadc2a19d4c8cf866d78f76ce80a7dec01058666fbd4ba/gameworksrestsdk-1.0.1-py3-none-any.whl" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "85e2bd5fef81da5199248ef9f977b5f8", "sha256": "1db88a0adf9032b8c9535c0b3b8cc7391ebd9280ac6af837c7b4b248a1d74074" }, "downloads": -1, "filename": "gameworksrestsdk-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "85e2bd5fef81da5199248ef9f977b5f8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14995, "upload_time": "2019-02-28T04:25:51", "url": "https://files.pythonhosted.org/packages/f3/bb/5462a697f3b825601e565066eb3855048bdfe42a6d632fa8740cb0bcddd7/gameworksrestsdk-1.0.2-py3-none-any.whl" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "342ac991ad843aae8c12ec8cb9a95031", "sha256": "99b1a9b30a89e004060d195690f85a808419eae9929054fede4cae2c06a8bd63" }, "downloads": -1, "filename": "gameworksrestsdk-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "342ac991ad843aae8c12ec8cb9a95031", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14994, "upload_time": "2019-02-28T04:29:08", "url": "https://files.pythonhosted.org/packages/f0/dd/a2b927666e9760def2be2baf121bf21b757c02c0b7d0bc0519e06904aab4/gameworksrestsdk-1.0.3-py3-none-any.whl" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "1e0b75ce3b9749b336fadae9f0c4baed", "sha256": "0af7e47f0bba1a7dd6109aece3de7ff418a2dd4e63a3e50ee7d91c1360ff0bf9" }, "downloads": -1, "filename": "gameworksrestsdk-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1e0b75ce3b9749b336fadae9f0c4baed", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15919, "upload_time": "2019-03-01T05:22:29", "url": "https://files.pythonhosted.org/packages/a9/ae/cc2a2d2f5abba1a4a063320dc763fc3ed8f5ce6072da46ce369299181f8d/gameworksrestsdk-1.1.0-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1e0b75ce3b9749b336fadae9f0c4baed", "sha256": "0af7e47f0bba1a7dd6109aece3de7ff418a2dd4e63a3e50ee7d91c1360ff0bf9" }, "downloads": -1, "filename": "gameworksrestsdk-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1e0b75ce3b9749b336fadae9f0c4baed", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15919, "upload_time": "2019-03-01T05:22:29", "url": "https://files.pythonhosted.org/packages/a9/ae/cc2a2d2f5abba1a4a063320dc763fc3ed8f5ce6072da46ce369299181f8d/gameworksrestsdk-1.1.0-py3-none-any.whl" } ] }