{ "info": { "author": "Andreas Sch\u00e4fer", "author_email": "", "bugtrack_url": null, "classifiers": [], "description": "# Base API Connector\n\nHelps create a simple API Connector where all you have to do is define the resources and possible commands.\n\n## Instructions\n\n### Using the Module\n\nFirst import the GenericAPIConnector class:\n\n```\nfrom base_api_connector import GenericAPIConnector\n```\n\nThen, define a base_api_url and resource fields like this:\n\n```\nclass ImplementedAPIConnector(GenericAPIConnector):\n base_api_url = 'http://127.0.0.1:8000/notes-backend/'\n reports = APIResource(('create', 'retrieve', 'update'))\n users = APIResource('all')\n```\nThat will generate the following attributes when you use the class:\n\n```\nconn = ImplementedAPIConnector()\n\nconn.reports.create(data)\nconn.reports.retrieve(pk)\nconn.reports update(pk, data)\n\nconn.users.list()\nconn.users.create(data)\nconn.users.retrieve(pk)\nconn.users.update(pk, data)\nconn.users.delete(pk)\n```\n\n### Asyncio\n\nYou can tell tell your resource fields that they should be accessed with asyncio per default:\n```\nclass ImplementedAPIConnector(GenericAPIConnector):\n # ...\n users = APIResource('all', is_async=True)\n```\nand then use it in an async metho as follows:\n```\nasync def create_user(user):\n r = await conn.user.create(user)\n data = await r.json()\n # ...\n```\nAlternatively, you can change switch to async in-line as well:\n```\n # ...\n r = await conn.reports(is_async=True).list()\n # ...\n```\nor the other way around:\n```\nr = conn.user(is_async=False).list()\n```\n\n### Using The Returned Object\n\nThe methods of GenericAPIConnector return a regular Response object from the requests module. See requests [Documentation for Response](https://2.python-requests.org/en/latest/api/#requests.Response) for more details.\n\n\n### Using AsDictObject (WIP)\n\nIf you want to define how a resource looks only once, import AsDictObject:\n```\nimport datetime\nfrom base_api_connecotr import AsDictObject\n\nclass CreateUsersResourceObject(AsDictObject):\n name = None # None will not pass the field in the request\n created = datetime.datetime.now # use methods to set defaults like this\n created_for_app = 'readme_example'\n```\n\nAnd then use it like this:\n```\nuser = CreateUsersResourceObject():\nuser.name = 'readme user'\nconn.users.create(user)\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/I-K0haku-I/base-api-connector", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "base-api-connector", "package_url": "https://pypi.org/project/base-api-connector/", "platform": "", "project_url": "https://pypi.org/project/base-api-connector/", "project_urls": { "Homepage": "https://github.com/I-K0haku-I/base-api-connector" }, "release_url": "https://pypi.org/project/base-api-connector/0.3.1.1/", "requires_dist": [ "requests", "aiohttp" ], "requires_python": "", "summary": "Generic Connector so you can easily create simple and readable classes for accessing APIs.", "version": "0.3.1.1" }, "last_serial": 5854868, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "65cbe2fea225d5bcdcbe1cc4622d993e", "sha256": "90d72a147604a2cc348ab39fff1aa46dbfbf31f648d19d10b3c8c882bec3bf72" }, "downloads": -1, "filename": "base_api_connector-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "65cbe2fea225d5bcdcbe1cc4622d993e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3612, "upload_time": "2019-04-30T11:44:15", "url": "https://files.pythonhosted.org/packages/ef/88/8833ca7f7620dfc7c9d7cfb4ce6735dc82c783baa03e7f9c2b9ccc86a3e9/base_api_connector-0.1.0-py3-none-any.whl" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "ed9ff899b3539bbd54cad8efa79b4942", "sha256": "643946e4ed216b45fed4766621ec06487175f41de8ff4263e9d33993a03e47ad" }, "downloads": -1, "filename": "base_api_connector-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "ed9ff899b3539bbd54cad8efa79b4942", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5106, "upload_time": "2019-04-30T12:03:39", "url": "https://files.pythonhosted.org/packages/15/94/1a0b26653604e9d921bf3324098be2a2c293e53b67e9252f979ebb0a5785/base_api_connector-0.1.1-py3-none-any.whl" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "66d43b3f5cf3c7e9e67fcc3dcb74999c", "sha256": "b65499b2cc9a7b14c3af721e49d470027b2deda764d0266c1a4d7bbe17dfda4b" }, "downloads": -1, "filename": "base_api_connector-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "66d43b3f5cf3c7e9e67fcc3dcb74999c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7057, "upload_time": "2019-04-30T12:48:30", "url": "https://files.pythonhosted.org/packages/e7/a3/0aa51c21c7ce40c45d976617484b78e3b2901ec1cad683db1ccc5c432511/base_api_connector-0.1.2-py3-none-any.whl" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "359c7554f692778fa83271264d23a915", "sha256": "98622b462a2812144dbf49545a7147fd3e0a7b5451304705d9d08d65dd0567a4" }, "downloads": -1, "filename": "base_api_connector-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "359c7554f692778fa83271264d23a915", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7411, "upload_time": "2019-04-30T13:37:19", "url": "https://files.pythonhosted.org/packages/ed/4f/e21179199427cafef697dd1268a26857c29b098b8c09e72cada3828f5b03/base_api_connector-0.1.3-py3-none-any.whl" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "96b118e70fd69a2f6160aae534d28dbf", "sha256": "13477e284de0ec9b0439cebfeb80f8af633d7d7bd51ccde2dde481b44f12d930" }, "downloads": -1, "filename": "base_api_connector-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "96b118e70fd69a2f6160aae534d28dbf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9138, "upload_time": "2019-05-28T14:09:24", "url": "https://files.pythonhosted.org/packages/23/5d/24aab7622e909e92ec78a7f85305256cec5ce3ca5fd435aba4b424258d09/base_api_connector-0.1.4-py3-none-any.whl" } ], "0.1.5.1": [ { "comment_text": "", "digests": { "md5": "1f32b4d1eaae583244e13645656fd42f", "sha256": "44ca4723e58be7dbad84417be758c54ec743772d6ae4b93a5a75d7c2e0653523" }, "downloads": -1, "filename": "base_api_connector-0.1.5.1-py3-none-any.whl", "has_sig": false, "md5_digest": "1f32b4d1eaae583244e13645656fd42f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9263, "upload_time": "2019-08-12T11:57:12", "url": "https://files.pythonhosted.org/packages/59/ea/f5bb490fad2cc388302accbecea6a47e6dc9b907b6dcb6e14b4083609c09/base_api_connector-0.1.5.1-py3-none-any.whl" } ], "0.1.5.2": [ { "comment_text": "", "digests": { "md5": "2130d90edfef4836857f760c13e917bf", "sha256": "cce7d08d6819ea97250de4a9b9f0df2d5063029db1c0b53c5b24f55b4c9a6923" }, "downloads": -1, "filename": "base_api_connector-0.1.5.2-py3-none-any.whl", "has_sig": false, "md5_digest": "2130d90edfef4836857f760c13e917bf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9277, "upload_time": "2019-08-12T12:16:32", "url": "https://files.pythonhosted.org/packages/9c/25/b49938a8f3a8d92a5b6e0ff31abc66f2f3fa8b26f24ea42d0b80f732dafa/base_api_connector-0.1.5.2-py3-none-any.whl" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "bc8a3dc40af69a2f6ab7a9bd88b841b5", "sha256": "3df582a068ae4726b3161917462e5ac94ae4111754a8b11e45c62042fef0a5b8" }, "downloads": -1, "filename": "base_api_connector-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "bc8a3dc40af69a2f6ab7a9bd88b841b5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9861, "upload_time": "2019-09-16T12:24:26", "url": "https://files.pythonhosted.org/packages/c4/d3/2f83f128240381368f1e022b18e77dc80201faa796b66d226afa2ea16b3c/base_api_connector-0.2-py3-none-any.whl" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "8ea2449ee71508b5744716ec8656a454", "sha256": "0b86354024f705ddd22f73ce64e4ba01d37689fea8516cd652dba256b81c6467" }, "downloads": -1, "filename": "base_api_connector-0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "8ea2449ee71508b5744716ec8656a454", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10795, "upload_time": "2019-09-18T14:19:30", "url": "https://files.pythonhosted.org/packages/37/0a/fe9eaaf05cce8d6f93a70139a3b6c859f9633d350c6551c1743551d4dc81/base_api_connector-0.3-py3-none-any.whl" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "38370d2960153e6c6ec61c13cf04b41c", "sha256": "6f738a6da86da1b4ca2b0b4f03cd8b5dd22955001ba2d18949a9e6d3a974823b" }, "downloads": -1, "filename": "base_api_connector-0.3.1-py3-none-any.whl", "has_sig": false, "md5_digest": "38370d2960153e6c6ec61c13cf04b41c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10810, "upload_time": "2019-09-18T14:25:38", "url": "https://files.pythonhosted.org/packages/27/99/1e9d48998270f0dac41928f57889b669fdb7c54e834ab69bd5491818ec03/base_api_connector-0.3.1-py3-none-any.whl" } ], "0.3.1.1": [ { "comment_text": "", "digests": { "md5": "407fa98b15b419c7dd4c1b6951a1f014", "sha256": "693eeee452d9383b651f9ddfc79f44dd0ac40da5877b29a0783cb11260b849a3" }, "downloads": -1, "filename": "base_api_connector-0.3.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "407fa98b15b419c7dd4c1b6951a1f014", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10824, "upload_time": "2019-09-19T08:38:54", "url": "https://files.pythonhosted.org/packages/bc/3a/9caaa4cde4df756585c74f2e914a40703ceb482494b7a16ae1ad7c3637bf/base_api_connector-0.3.1.1-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "407fa98b15b419c7dd4c1b6951a1f014", "sha256": "693eeee452d9383b651f9ddfc79f44dd0ac40da5877b29a0783cb11260b849a3" }, "downloads": -1, "filename": "base_api_connector-0.3.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "407fa98b15b419c7dd4c1b6951a1f014", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10824, "upload_time": "2019-09-19T08:38:54", "url": "https://files.pythonhosted.org/packages/bc/3a/9caaa4cde4df756585c74f2e914a40703ceb482494b7a16ae1ad7c3637bf/base_api_connector-0.3.1.1-py3-none-any.whl" } ] }