{ "info": { "author": "iotec", "author_email": "dev@dsp.io", "bugtrack_url": null, "classifiers": [], "description": "# Beeswax Wrapper\n\nThe beeswax wrapper is a python API for the beeswax DSP\n\nbeeswax_wrapper is currently supported for python2 and python3.\n\n\n# Installation\n```console\n$ pip install beeswax_wrapper\n```\n\n## Imports\n```python\n>>> from beeswax_wrapper import BeeswaxAPI, configure_endpoint\n```\n`BeeswaxAPI` is the main interface to the package. \nIt allows for seamless communication with the true beeswax API.\nThe API lazily loads a `BeeswaxDAL` to access the API and manage authentication state. \nThe `BeeswaxDAL` is shared among all BeeswaxAPI classes.\n\n`get_beeswax_dal()` returns the single `BeeswaxDAL` object used by the apis. \nModifying the `BeeswaxDAL` object returned by this function affects all `BeeswaxAPI` classes. \nUpdates should be made to this dal using the `configure_endpoint` function as follows:\n```python\n>>> from beeswax_wrapper import BeeswaxAPI, configure_endpoint\n>>> api = BeeswaxAPI()\n>>> configure_endpoint('http://endpoint.api.beeswax.com/rest/')\n>>> api.dal.endpoint_url\n'http://endpoint.api.beeswax.com/rest/'\n```\n\n## Methods\nThe `BeeswaxAPI` operates with an object restful structure. \nThe basic method calls are organised as `api..` where the restful methods are:\n- retrieve\n- list\n- create\n- update\n- delete\n\nSome keywords that are specific to each restful endpoint are supplied but the full list of keywords is available here: \nhttps://docs.beeswax.com/docs/getting-started\n\n### Examples\n```python\n>>> from beeswax_wrapper import BeeswaxAPI\n>>> api = BeeswaxAPI()\n\n>>> # get account information for an id\n>>> api.accounts.retrieve(account_id=4)\n\n>>> # get a list of campaigns\n>>> api.campaigns.list()\n\n>>> # delete a lineitem by id\n>>> api.line_items.delete(line_item_id=62)\n\n>>> # change user\n>>> api.change_user('', '')\n>>> # cookies are preserved per class\n```\n\n## Exceptions\nThe `BeeswaxAPI` is metaclassed to raise only a `BeeswaxRESTException`.\n\n## Authentication\nThe `beeswax_wrapper` authenticates once per `BeeswaxDAL` instance. The authentication is for short connection durations only. \nIn the event that a connection times out or is unavailable, the `BeeswaxDAL` will attempt to re-authenticate.\nCredentials from the DAL are queried from the os keyring. \n\n### Adding credentials\n```console\n$ python beeswax_wrapper/credentials/credential_manager.py\nBeeswax Username:\nBeeswax Password:\n$\n```", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/iotgdev/beeswax_wrapper/archive/1.1.9.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/iotgdev/beeswax_wrapper/", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "beeswax-wrapper", "package_url": "https://pypi.org/project/beeswax-wrapper/", "platform": "Development Status :: 5 - Production/Stable", "project_url": "https://pypi.org/project/beeswax-wrapper/", "project_urls": { "Download": "https://github.com/iotgdev/beeswax_wrapper/archive/1.1.9.tar.gz", "Homepage": "https://github.com/iotgdev/beeswax_wrapper/" }, "release_url": "https://pypi.org/project/beeswax-wrapper/1.1.9/", "requires_dist": null, "requires_python": "", "summary": "Python Wrapper for the Beeswax API", "version": "1.1.9" }, "last_serial": 5409313, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "67c25e779bff85dc789e866ccb13094a", "sha256": "1211115ed3a8fc5e78c47b3be380ef60c3dabf9b8c01e76710f3fc5e404f6219" }, "downloads": -1, "filename": "beeswax_wrapper-1.0.0-py2-none-any.whl", "has_sig": false, "md5_digest": "67c25e779bff85dc789e866ccb13094a", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 16963, "upload_time": "2018-09-05T14:37:03", "url": "https://files.pythonhosted.org/packages/88/74/478740acb7f6ec4c5a7a39733b45707576fa46cd972002a77cdcb6b1adfa/beeswax_wrapper-1.0.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dfe7e7ac7611e1be6485c800e824aae8", "sha256": "ebb3b26952acf6d03e2d00695a22a0b233db574677ecd57edd4c24504073be7c" }, "downloads": -1, "filename": "beeswax_wrapper-1.0.0.tar.gz", "has_sig": false, "md5_digest": "dfe7e7ac7611e1be6485c800e824aae8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11783, "upload_time": "2018-09-05T14:37:04", "url": "https://files.pythonhosted.org/packages/45/5c/285313983bd8776b8c0d8a849b41d127bf7eab2e987b871077cd7491dcaa/beeswax_wrapper-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "87c6682ed32829ecb54de8a4654d3293", "sha256": "8eaeae8cf17fdca28c2622a742d0712d95ffeaeb37818a76f275b4dd540cc993" }, "downloads": -1, "filename": "beeswax_wrapper-1.0.1-py2-none-any.whl", "has_sig": false, "md5_digest": "87c6682ed32829ecb54de8a4654d3293", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 16893, "upload_time": "2018-09-08T08:40:33", "url": "https://files.pythonhosted.org/packages/90/af/3ecbb22ea170547c37cb71a72264fa77a5c01e8bb57cdb9255370ab86f4b/beeswax_wrapper-1.0.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6dcb0eba4522389772704a7f53666da5", "sha256": "eeae93e186f0c7334d241a4f3576d1016d62d61147cb6182532a7c5f3da2de37" }, "downloads": -1, "filename": "beeswax_wrapper-1.0.1.tar.gz", "has_sig": false, "md5_digest": "6dcb0eba4522389772704a7f53666da5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11673, "upload_time": "2018-09-08T08:40:35", "url": "https://files.pythonhosted.org/packages/ca/7c/93f725e0f1295dd121c475a991e7ced592e00bcd7fc52df248ae310931a0/beeswax_wrapper-1.0.1.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "5bc00f739c90b0ee52918ea0d96d6735", "sha256": "ae49961febdaaf6bccb40c2348c912f1a8dd3b497f5694e841878fa00967fe50" }, "downloads": -1, "filename": "beeswax_wrapper-1.1.0.tar.gz", "has_sig": false, "md5_digest": "5bc00f739c90b0ee52918ea0d96d6735", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12082, "upload_time": "2018-09-19T12:11:42", "url": "https://files.pythonhosted.org/packages/04/aa/800dc8e6f7f20315062222f7bd2596b9da9466ba3d420e418849eb0d59f4/beeswax_wrapper-1.1.0.tar.gz" } ], "1.1.2": [ { "comment_text": "", "digests": { "md5": "06f95dcf59b84b9b6cb942bf0fc7df8a", "sha256": "549f314866f3ce927890feac8d3b3ba18ffa5d6dd6f5ddba5c9bb68dcf6780d4" }, "downloads": -1, "filename": "beeswax_wrapper-1.1.2.tar.gz", "has_sig": false, "md5_digest": "06f95dcf59b84b9b6cb942bf0fc7df8a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11805, "upload_time": "2018-09-21T19:19:15", "url": "https://files.pythonhosted.org/packages/24/c5/7fcabd9cdd75f3ee7c654ca9c32181e4adabe4f34f29265bb4e1f7b47002/beeswax_wrapper-1.1.2.tar.gz" } ], "1.1.3": [ { "comment_text": "", "digests": { "md5": "e6c21ba1896e86b12f07325a9d49e9f8", "sha256": "c04c18971a20270a8747471f76e0befd1957fc52ec91f3045af6fe0a37552b2d" }, "downloads": -1, "filename": "beeswax_wrapper-1.1.3.tar.gz", "has_sig": false, "md5_digest": "e6c21ba1896e86b12f07325a9d49e9f8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12050, "upload_time": "2018-09-21T19:29:39", "url": "https://files.pythonhosted.org/packages/4a/a1/ff9e88763d8156ce83542cd431cc3c0d8cfa7660192009ce9b0a07ccd476/beeswax_wrapper-1.1.3.tar.gz" } ], "1.1.4": [ { "comment_text": "", "digests": { "md5": "0526f1c4aef61f630a23fbf7333e7aa9", "sha256": "86e98c53f92c345a5f9e92d4e5cfc4848ab75e9fd0d294428215a8b8a2e93cdd" }, "downloads": -1, "filename": "beeswax_wrapper-1.1.4.tar.gz", "has_sig": false, "md5_digest": "0526f1c4aef61f630a23fbf7333e7aa9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15564, "upload_time": "2018-09-22T14:09:52", "url": "https://files.pythonhosted.org/packages/be/4a/c03683bf7873445339fb62044c53721a1fd1e5de90da8ef41751cd3e2b89/beeswax_wrapper-1.1.4.tar.gz" } ], "1.1.5": [ { "comment_text": "", "digests": { "md5": "cceb1ba711654818a62e38f3fc4602b0", "sha256": "28bf7a8ea0e90fcdae33d33908af59751c5f8a582d427d793c0e6584abd754d6" }, "downloads": -1, "filename": "beeswax_wrapper-1.1.5.tar.gz", "has_sig": false, "md5_digest": "cceb1ba711654818a62e38f3fc4602b0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13354, "upload_time": "2018-09-26T10:54:52", "url": "https://files.pythonhosted.org/packages/85/3e/f40fa6c32f41273edbae250860e0a6c5dd218deaeaa3fbd627b81a894496/beeswax_wrapper-1.1.5.tar.gz" } ], "1.1.6": [ { "comment_text": "", "digests": { "md5": "058189b45a19d57719d6cfde59a2ac72", "sha256": "c756593fd43376b23cb2c3a9435f2d2e35c56ef27a8b370bd1b017e057f9ab2f" }, "downloads": -1, "filename": "beeswax_wrapper-1.1.6.tar.gz", "has_sig": false, "md5_digest": "058189b45a19d57719d6cfde59a2ac72", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13362, "upload_time": "2018-09-26T12:48:57", "url": "https://files.pythonhosted.org/packages/97/39/6334360373de7558e30aceac82a6774f49304850c4a76831f733d03c313d/beeswax_wrapper-1.1.6.tar.gz" } ], "1.1.7": [ { "comment_text": "", "digests": { "md5": "b6bee1623850640d95eb08507cf8ebc1", "sha256": "fe5bd5bd7ee21bc84008fe741e638dc4e27eb3699cbf821f1d56b03756065b6c" }, "downloads": -1, "filename": "beeswax_wrapper-1.1.7.tar.gz", "has_sig": false, "md5_digest": "b6bee1623850640d95eb08507cf8ebc1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13373, "upload_time": "2018-09-28T13:16:41", "url": "https://files.pythonhosted.org/packages/42/6d/cdc3a39965382cb2146bbd69f42c7ec681de1aa7feecb3e56e0140d65b4a/beeswax_wrapper-1.1.7.tar.gz" } ], "1.1.8": [ { "comment_text": "", "digests": { "md5": "35f5a3996f0b41cd84d0fb5aa1640a45", "sha256": "876a10000f46a1e9807d5a7ea60c685fec89dd7bd6c12752c99831569b3f3f0a" }, "downloads": -1, "filename": "beeswax_wrapper-1.1.8.tar.gz", "has_sig": false, "md5_digest": "35f5a3996f0b41cd84d0fb5aa1640a45", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14743, "upload_time": "2018-10-02T10:46:24", "url": "https://files.pythonhosted.org/packages/7b/70/8d38348cc281ae4e9e3530194c97eced2e2af363ec8b54aa04558f90c9e2/beeswax_wrapper-1.1.8.tar.gz" } ], "1.1.9": [ { "comment_text": "", "digests": { "md5": "e50e4644b13b7da9e0966ef3ff3f3444", "sha256": "81b9db8405388ef2e83f61dba88f9b6906adc14dc3b1dfbf0ff1c2c8a3953d25" }, "downloads": -1, "filename": "beeswax-wrapper-1.1.9.tar.gz", "has_sig": false, "md5_digest": "e50e4644b13b7da9e0966ef3ff3f3444", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13657, "upload_time": "2019-06-17T09:27:40", "url": "https://files.pythonhosted.org/packages/c7/74/3053b00b692fed18886e59891cdf482c00b08109315962c6fee9fbf6525c/beeswax-wrapper-1.1.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e50e4644b13b7da9e0966ef3ff3f3444", "sha256": "81b9db8405388ef2e83f61dba88f9b6906adc14dc3b1dfbf0ff1c2c8a3953d25" }, "downloads": -1, "filename": "beeswax-wrapper-1.1.9.tar.gz", "has_sig": false, "md5_digest": "e50e4644b13b7da9e0966ef3ff3f3444", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13657, "upload_time": "2019-06-17T09:27:40", "url": "https://files.pythonhosted.org/packages/c7/74/3053b00b692fed18886e59891cdf482c00b08109315962c6fee9fbf6525c/beeswax-wrapper-1.1.9.tar.gz" } ] }