{ "info": { "author": "Edward Beech", "author_email": "edward.beech@ftpsolutions.com.au", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Libraries" ], "description": "# ims-python-api-connector\n\nConnector for the FTP Technologies IMS HTTP API\n\n## How to install\n\n`$ pip install ims-api-connector`\n\n## How to use\n\nThere are `.connect()` and `.close()` methods exposed as well as a context manager API (`__enter__()` and `__exit__()`) but you don't have to use either- simply calling `.get()`, `.post()` etc will handle the authentication for you.\n\nAdditionally, it will retry authentication if it picks up an authentication error during a request (to handle expired tokens etc) but if the attempt to re-authenticate fails, it will stop retrying.\n\n```\nfrom ims_api_connector import IMSAPIConnector\n\nconnector = IMSAPIConnector(\n url='https://some.ims.instance.com/api/',\n username='some_username',\n password='some_password',\n timeout=5, # optional; seconds until a request times out\n retries=6, # optional; number of re-auth attempts during a request\n backoff=5, # optional; seconds between re-auth attempts\n insecure=False, # optional; ignore certificate warnings\n logger=None, # optional; Python logger object\n)\n\nconnector.get('assets/?limit=50000')\n```\n\nWhich returns an object like this:\n\n```\nResponse(\n status_code=200,\n text='{\"some\": \"data\"}',\n json={'some': 'data'},\n error=None, # any JSON parse exception object\n traceback=None, # traceback string for JSON parse exception\n)\n```\n\n## How to develop\n\nPrerequisites:\n\n* pip\n* virtualenvwrapper\n* entr\n\nInstructions:\n\n* Create a virtualenv\n * `mkvirtualenv ims-python-api-connector`\n* Install the requirements\n * `pip install -r requirements.txt`\n* Watch the tests\n * ./watch_tests.sh\n* Write some code\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/initialed85/ims-python-api-connector", "keywords": "sample setuptools development", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "ims-api-connector", "package_url": "https://pypi.org/project/ims-api-connector/", "platform": "", "project_url": "https://pypi.org/project/ims-api-connector/", "project_urls": { "Homepage": "https://github.com/initialed85/ims-python-api-connector" }, "release_url": "https://pypi.org/project/ims-api-connector/2018.2/", "requires_dist": [ "requests (==2.18.4)", "check-manifest; extra == 'dev'", "coverage; extra == 'test'" ], "requires_python": "", "summary": "A connector for the FTP Technologies IMS API", "version": "2018.2" }, "last_serial": 5920871, "releases": { "2018.1": [ { "comment_text": "", "digests": { "md5": "75b11eed3fea75afa7d9a491b0cfa897", "sha256": "158a7b0db6ac3897f4764372e186f769b9cb839db4622e228d1f03ac80d81b24" }, "downloads": -1, "filename": "ims_api_connector-2018.1-py3-none-any.whl", "has_sig": false, "md5_digest": "75b11eed3fea75afa7d9a491b0cfa897", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6582, "upload_time": "2018-04-04T15:49:20", "url": "https://files.pythonhosted.org/packages/20/a0/10c3c9973f0557c1e2492008fdede6e627e5431b6610687b7862c42ff2d5/ims_api_connector-2018.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6bfe1cb371dd284fb6c4f88b11adb821", "sha256": "8ac76ed5dbcbfee22b349687845ad3c4ed83103a201a18453822fc16458838b5" }, "downloads": -1, "filename": "ims-api-connector-2018.1.tar.gz", "has_sig": false, "md5_digest": "6bfe1cb371dd284fb6c4f88b11adb821", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5866, "upload_time": "2018-04-04T15:49:22", "url": "https://files.pythonhosted.org/packages/dd/39/f40c6f9edbaa03d0633cbc8f8b0abbdc463d09dcb7e13ca8a7e37ced67a5/ims-api-connector-2018.1.tar.gz" } ], "2018.2": [ { "comment_text": "", "digests": { "md5": "9c67e76d4a6c7f45cfba6be7e1797955", "sha256": "be9980854a74c6bd932d6f25d7987f6993f52b106ba13dd1c2b2fabfe5ace685" }, "downloads": -1, "filename": "ims_api_connector-2018.2-py3-none-any.whl", "has_sig": false, "md5_digest": "9c67e76d4a6c7f45cfba6be7e1797955", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6646, "upload_time": "2018-04-04T15:52:33", "url": "https://files.pythonhosted.org/packages/11/92/6e4f641ef10994247c6c3df6487e7d9acf75337364723cbb1f390f2d1e73/ims_api_connector-2018.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c0a93dff2e7111000a9287f0c7dcb374", "sha256": "fd91f2535fd6d6b0bedc0e7b0888b96a2b4888a1c182ea88ce900f158ff6c16f" }, "downloads": -1, "filename": "ims-api-connector-2018.2.tar.gz", "has_sig": false, "md5_digest": "c0a93dff2e7111000a9287f0c7dcb374", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5900, "upload_time": "2018-04-04T15:52:34", "url": "https://files.pythonhosted.org/packages/55/68/c21f2fb0758e5724e0235a33003d6c1ee8ee695f5c6da98adc24e36fcead/ims-api-connector-2018.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9c67e76d4a6c7f45cfba6be7e1797955", "sha256": "be9980854a74c6bd932d6f25d7987f6993f52b106ba13dd1c2b2fabfe5ace685" }, "downloads": -1, "filename": "ims_api_connector-2018.2-py3-none-any.whl", "has_sig": false, "md5_digest": "9c67e76d4a6c7f45cfba6be7e1797955", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6646, "upload_time": "2018-04-04T15:52:33", "url": "https://files.pythonhosted.org/packages/11/92/6e4f641ef10994247c6c3df6487e7d9acf75337364723cbb1f390f2d1e73/ims_api_connector-2018.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c0a93dff2e7111000a9287f0c7dcb374", "sha256": "fd91f2535fd6d6b0bedc0e7b0888b96a2b4888a1c182ea88ce900f158ff6c16f" }, "downloads": -1, "filename": "ims-api-connector-2018.2.tar.gz", "has_sig": false, "md5_digest": "c0a93dff2e7111000a9287f0c7dcb374", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5900, "upload_time": "2018-04-04T15:52:34", "url": "https://files.pythonhosted.org/packages/55/68/c21f2fb0758e5724e0235a33003d6c1ee8ee695f5c6da98adc24e36fcead/ims-api-connector-2018.2.tar.gz" } ] }