{ "info": { "author": "Adam Peretti", "author_email": "adam.peretti@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "## Settle SDK\nThe Settle SDK abstracts using the price feed and settle API by wrapping authentication in a function.\n\n[Documentation](https://docs.settle.finance/)\n\n[Support channel](https://discord.gg/9C9NYVc)\n\n\n```\npip install settlesdk\n```\n\n## Versions\n0.0.4v Fixed GUID from Token\n0.0.7v Fixed GUID to Username\n\n## How it works\nInstead of authenticating and running requests yourself, use the settle object to run api functions.\n\nFor example\n```\nfrom settlesdk import PriceList\npricelist = PriceList()\ncoins = pricelist.ticker({'id': 1})\n```\n\n## Important - Authentication\nYou need to register an app in settle in order to use the API. Head over to https://settle.finance/app/developer-tools and join our developer program.\n\n![Alt text](https://github.com/SettleFinance/Settle-SDK/raw/master/Images/app-permission.png?raw=true)\n\nSet an app name and grab the automatically generated API keys. Update your .env file in your projects root so that SETTLE_API_KEY and SETTLE_API_SECRET reflect your keys. If your app doesn't use environment variables yet, you will need to setup a loader like [dotenv](https://www.npmjs.com/package/dotenv).\n\n```\nSETTLE_API_KEY = \"API KEY HERE\"\nSETTLE_API_SECRET = \"API SECRET HERE\"\n```\n\nYou can now access the Settle SDK!\n\n### Testing user specific endpoints\n#### You can access the price feed API, but to access a users portfolio they need to install your app and opt into providing their data to you.\n\nIn your developer tools, https://settle.finance/app/developer-tools, select \"portfolio\" in data access permissions and click the install button to try opting into your app before it's available in the app store.\n\n## [API reference ](https://docs.settle.finance/display/SP/API+Documentation)\n\n## User specific apps\nWhen your app or chat plugin is loaded inside of settle, we will pass a user_id get param (?user_id) along with the app mode (?mode).\n\n#### Exchange token for a user id\n```\nfrom settlesdk import User\nuser = User()\nuser.exchangeTokenForGuid({'token': token})\n\n```\n\n## Examples\n\n#### Return ticker information about Bitcoin\n```\nfrom settlesdk import PriceFeed\npricefeed = PriceFeed()\npricefeed.ticker({'token': token})\n```\n\n#### Convert a GUID to a username\n```\nfrom settlesdk import User\nuser = User()\nuser.guid_to_username({'token': token})\n```\n\n#### Send an custom hub event\n```\nfrom settlesdk import Chat\nchat = Chat()\nchat.sendEvent({ chatId, message })\n```\n\n#### Send a notification to a user\n```\nfrom settlesdk import App\napp = App()\napp.send_notification({guid: guid})\n```\n\n#### Return a users holdings with a list of trades for each asset\n```\nfrom settlesdk import Portfolio\nportfolio = Portfolio()\nportfolio.HoldingsWithTrades({ 'guid': user_id })\n```\n\n#### Return a list of users who installed my app\n```\nfrom settlesdk import App\napp = App()\napp.users()\n```\n\n#### Send Notification to users with installed app\n```\nfrom settlesdk import App\napp = App()\nusers = app.users()\nfor user in users:\n app.send_notification({'guid': user.guid})\n```\n\n\n#### Return Requests response with data\n```\nfrom settlesdk import App\napp = App()\nusers, response = app.user(include_response=True)\nprint(response.status_code)\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/SettleFinance/Settle-SDK-Python", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "settlesdk", "package_url": "https://pypi.org/project/settlesdk/", "platform": "", "project_url": "https://pypi.org/project/settlesdk/", "project_urls": { "Homepage": "https://github.com/SettleFinance/Settle-SDK-Python" }, "release_url": "https://pypi.org/project/settlesdk/0.0.7/", "requires_dist": [ "PyJWT", "python-dotenv", "requests", "cryptography" ], "requires_python": "", "summary": "The Settle SDK abstracts using the price feed and settle API by wrapping authentication in a function.", "version": "0.0.7" }, "last_serial": 4614795, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "c8d7a807a9bf84d13009c8177da48b98", "sha256": "13b7702ddba422f6dfe8acb746a527eea02613f270857f68c83aa707fd8666da" }, "downloads": -1, "filename": "settlesdk-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "c8d7a807a9bf84d13009c8177da48b98", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4511, "upload_time": "2018-11-26T03:56:33", "url": "https://files.pythonhosted.org/packages/0c/c9/6dabc36a0d69c47697adff7316b92e65511acfab9acac990874595574fd9/settlesdk-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "94f57bde544b5547e747e8e63a539ba0", "sha256": "6a7ee239cf122a2584ff608e02cebb2cb27711153489d8fee977f6a3cd5595a0" }, "downloads": -1, "filename": "settlesdk-0.0.1.tar.gz", "has_sig": false, "md5_digest": "94f57bde544b5547e747e8e63a539ba0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3551, "upload_time": "2018-11-26T03:56:38", "url": "https://files.pythonhosted.org/packages/87/a0/1a94ddd3893f5c96e318ef7443ad91faf55919484d3f2cd4c0b87da9876f/settlesdk-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "711871d46c3a7783958292f400eff60b", "sha256": "992f48669fac94a31f68e1d1b2e446889ca9d89bb542e24ca14978a6d882167a" }, "downloads": -1, "filename": "settlesdk-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "711871d46c3a7783958292f400eff60b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4519, "upload_time": "2018-11-26T03:56:35", "url": "https://files.pythonhosted.org/packages/24/b6/e333618967b0b9fd5b3b47362949cfeb992976e45b70a71c34cc81badf36/settlesdk-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2862b60879604b4007e91e9d7ff574f8", "sha256": "1dd3b07a4eee92dfbe6271a19de3d33ce933cdfed962547c03cb61b67d137e6d" }, "downloads": -1, "filename": "settlesdk-0.0.2.tar.gz", "has_sig": false, "md5_digest": "2862b60879604b4007e91e9d7ff574f8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3560, "upload_time": "2018-11-26T03:56:39", "url": "https://files.pythonhosted.org/packages/02/35/ddb36cd6b72283e81307c23e54c1aea97400e3e808a2a2695c03dedafd6a/settlesdk-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "3c2b795cea5004bc5cde9ee523569f60", "sha256": "5f9f79a2236dbada754a15eea7ea0e681daac5bce271fa23044ddb0d953cb7ea" }, "downloads": -1, "filename": "settlesdk-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "3c2b795cea5004bc5cde9ee523569f60", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4545, "upload_time": "2018-11-26T03:56:36", "url": "https://files.pythonhosted.org/packages/c5/7d/b0edad5807079a02a5339173b7142c77f441cd509b8a876c00756835fc8a/settlesdk-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d65a0f703c8cf2a291d3ea63babc6697", "sha256": "d15a0d38ad4822c044d10b8cd9a1d14f9a5efbf84f41dc7ce02c8f1bc626df26" }, "downloads": -1, "filename": "settlesdk-0.0.3.tar.gz", "has_sig": false, "md5_digest": "d65a0f703c8cf2a291d3ea63babc6697", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3587, "upload_time": "2018-11-26T03:56:40", "url": "https://files.pythonhosted.org/packages/8f/9c/7cd46b071075afa87e159906c74ff1d82e8201301898f2bb9ba32e80f81a/settlesdk-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "7e46292f3271593c313986af14ddfda0", "sha256": "0bf633a0fc4ae9a15051c2bc0aa211242621c8889d6f8a195e975b04ef5ade92" }, "downloads": -1, "filename": "settlesdk-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "7e46292f3271593c313986af14ddfda0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5517, "upload_time": "2018-12-17T20:34:45", "url": "https://files.pythonhosted.org/packages/e7/73/09867f2403d9595a27cd6d41ebb7ad84bbd8f2282abf8a9bd2394bf76be0/settlesdk-0.0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "00a657e9483592975c1444bb4c369c3b", "sha256": "c183268161f91c044c48f4d02161a406cc27b4ecf22be6ce2fa5696172c527a4" }, "downloads": -1, "filename": "settlesdk-0.0.4.tar.gz", "has_sig": false, "md5_digest": "00a657e9483592975c1444bb4c369c3b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4656, "upload_time": "2018-12-17T20:34:48", "url": "https://files.pythonhosted.org/packages/da/7b/19d465799b1f13a917ff623c9e8228b57707c8d9dfa6b306290e7b3c7e47/settlesdk-0.0.4.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "92a0b597059198b3e159bf12478be2f3", "sha256": "e0a971645d53a73fab95150ac7d96bf3ab102977cfb2a80171d5e07b618b2e67" }, "downloads": -1, "filename": "settlesdk-0.0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "92a0b597059198b3e159bf12478be2f3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5476, "upload_time": "2018-12-17T21:09:30", "url": "https://files.pythonhosted.org/packages/1b/06/9ee4bf381476d09002eec3f5ba3baafb4f48815c1203370f11c773f52c26/settlesdk-0.0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "543979df047daaea23aa2ed11e91e371", "sha256": "b3c24f0f420379b55c781954ead9e843f71736f1dde24834f65324caf9d535ea" }, "downloads": -1, "filename": "settlesdk-0.0.6.tar.gz", "has_sig": false, "md5_digest": "543979df047daaea23aa2ed11e91e371", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4661, "upload_time": "2018-12-17T21:09:31", "url": "https://files.pythonhosted.org/packages/d0/02/b6c72413df2c2bae8b4ec9b57627ab382e6abcb5a82bc5f74d7dc75fb7f3/settlesdk-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "216a01c5e121ec1b11c1ea51b5970836", "sha256": "efdad805e878d1e4098c9cc32b56bbe3be6182629e263f074db06063e16a64af" }, "downloads": -1, "filename": "settlesdk-0.0.7-py3-none-any.whl", "has_sig": false, "md5_digest": "216a01c5e121ec1b11c1ea51b5970836", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5498, "upload_time": "2018-12-19T02:33:18", "url": "https://files.pythonhosted.org/packages/e7/3d/c9e0a97255bd0937a58521e14ff452ff6de7a2dd770edb89c79a0793c4df/settlesdk-0.0.7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "62c79fca48e3fc0d0dd288a364975e72", "sha256": "1f8f32155d1074587bbe0883b67c2fcf4df15d7f4982d129fbc9e1a89124ed26" }, "downloads": -1, "filename": "settlesdk-0.0.7.tar.gz", "has_sig": false, "md5_digest": "62c79fca48e3fc0d0dd288a364975e72", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4677, "upload_time": "2018-12-19T02:33:19", "url": "https://files.pythonhosted.org/packages/36/3e/5c19311065bd94f96b959494e8cc2f27a4985c7367d4adbea8f1bb7da3df/settlesdk-0.0.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "216a01c5e121ec1b11c1ea51b5970836", "sha256": "efdad805e878d1e4098c9cc32b56bbe3be6182629e263f074db06063e16a64af" }, "downloads": -1, "filename": "settlesdk-0.0.7-py3-none-any.whl", "has_sig": false, "md5_digest": "216a01c5e121ec1b11c1ea51b5970836", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5498, "upload_time": "2018-12-19T02:33:18", "url": "https://files.pythonhosted.org/packages/e7/3d/c9e0a97255bd0937a58521e14ff452ff6de7a2dd770edb89c79a0793c4df/settlesdk-0.0.7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "62c79fca48e3fc0d0dd288a364975e72", "sha256": "1f8f32155d1074587bbe0883b67c2fcf4df15d7f4982d129fbc9e1a89124ed26" }, "downloads": -1, "filename": "settlesdk-0.0.7.tar.gz", "has_sig": false, "md5_digest": "62c79fca48e3fc0d0dd288a364975e72", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4677, "upload_time": "2018-12-19T02:33:19", "url": "https://files.pythonhosted.org/packages/36/3e/5c19311065bd94f96b959494e8cc2f27a4985c7367d4adbea8f1bb7da3df/settlesdk-0.0.7.tar.gz" } ] }