{ "info": { "author": "Department for International Trade", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.11", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "# directory-api-client-external\n\n[![code-climate-image]][code-climate]\n[![circle-ci-image]][circle-ci]\n[![codecov-image]][codecov]\n[![pypi-image]][pypi]\n\n**Export Directory external API client.**\n\n---\n\n## Installation\n\n```sh\n $ pip install directory-api-external\n```\n\nThe api client expects the following settings:\n\n| Setting | Notes |\n| --------------------------------------------- | ----------------------------------------------------------- |\n| DIRECTORY_API_CLIENT_EXTERNAL_BASE_URL | |\n| DIRECTORY_API_CLIENT_EXTERNAL_API_KEY | Unique to client. Retrieved during the on-boarding process. |\n| DIRECTORY_API_CLIENT_EXTERNAL_SENDER_ID | Unique to client. Retrieved during the on-boarding process. |\n| DIRECTORY_API_CLIENT_EXTERNAL_DEFAULT_TIMEOUT | |\n\nOnce that is done the API client can be used:\n\n```py\nfrom directory_api_external.client import api_client\n```\n\n\n## Development\n\n $ git clone https://github.com/uktrade/directory-api-client-external\n $ cd directory-api-client-external\n\n## Publish to PyPI\n\nThe package should be published to PyPI on merge to master. If you need to do it locally then get the credentials from rattic and add the environment variables to your host machine:\n\n| Setting |\n| --------------------------- |\n| DIRECTORY_PYPI_USERNAME |\n| DIRECTORY_PYPI_PASSWORD |\n\n\nThen run the following command:\n\n make publish\n\n\n[code-climate-image]: https://codeclimate.com/github/uktrade/directory-api-client-external/badges/issue_count.svg\n[code-climate]: https://codeclimate.com/github/uktrade/directory-api-client-external\n\n[circle-ci-image]: https://circleci.com/gh/uktrade/directory-api-client-external/tree/master.svg?style=svg\n[circle-ci]: https://circleci.com/gh/uktrade/directory-api-client-external/tree/master\n\n[codecov-image]: https://codecov.io/gh/uktrade/directory-api-client-external/branch/master/graph/badge.svg\n[codecov]: https://codecov.io/gh/uktrade/directory-api-client-external\n\n[pypi-image]: https://badge.fury.io/py/directory-api-external.svg\n[pypi]: https://badge.fury.io/py/directory-api-external\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/uktrade/directory-api-client", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "directory-api-external", "package_url": "https://pypi.org/project/directory-api-external/", "platform": "", "project_url": "https://pypi.org/project/directory-api-external/", "project_urls": { "Homepage": "https://github.com/uktrade/directory-api-client" }, "release_url": "https://pypi.org/project/directory-api-external/5.0.0/", "requires_dist": [ "directory-client-core (<5.0.0,>=4.0.2)" ], "requires_python": "", "summary": "Python API client for Export Directory.", "version": "5.0.0" }, "last_serial": 4676523, "releases": { "4.1.1": [ { "comment_text": "", "digests": { "md5": "7a70188a67b3cc3fd56758233b2d3d8d", "sha256": "bc91ad5c80de020113e4a4c83f7d57f016a608a6eef7028da82988a302334dac" }, "downloads": -1, "filename": "directory_api_external-4.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "7a70188a67b3cc3fd56758233b2d3d8d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5828, "upload_time": "2018-03-06T17:02:09", "url": "https://files.pythonhosted.org/packages/4a/e9/9226801e168445250bd4eb9686403beb69e0929c75a26eb6ecef38a95017/directory_api_external-4.1.1-py3-none-any.whl" } ], "4.2.0": [ { "comment_text": "", "digests": { "md5": "0d16a605a0f16c8b30324c98e5ad88b2", "sha256": "9307120e9aaacc94e713e97bd6cd064cefa919a11db1b024888a676f516b4ab0" }, "downloads": -1, "filename": "directory_api_external-4.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "0d16a605a0f16c8b30324c98e5ad88b2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5830, "upload_time": "2018-03-06T17:25:23", "url": "https://files.pythonhosted.org/packages/ea/aa/9543c1ca4152abdaae8e8f3436d7683d3e7eb2eb07aa393466d3c020c7ce/directory_api_external-4.2.0-py3-none-any.whl" } ], "4.2.1": [ { "comment_text": "", "digests": { "md5": "c0cfa14b2a8d38b8cfbefbce5d893e14", "sha256": "ed12bb0101037eb6bf921607e08f502bb687310d182fc34f97e611f5c6b5757a" }, "downloads": -1, "filename": "directory_api_external-4.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "c0cfa14b2a8d38b8cfbefbce5d893e14", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5508, "upload_time": "2018-03-06T22:08:22", "url": "https://files.pythonhosted.org/packages/4d/c0/238120d4dc723cc8d86535bd9dcbfcba947625e56550a43cd384afea1a19/directory_api_external-4.2.1-py3-none-any.whl" } ], "4.2.2": [ { "comment_text": "", "digests": { "md5": "c39be7600cc2d3d11239fba0bcdbccfc", "sha256": "f6fda0a11149fc661654e23beb23bbb50ce126f161abeb36be3893ca65fe4197" }, "downloads": -1, "filename": "directory_api_external-4.2.2-py3-none-any.whl", "has_sig": false, "md5_digest": "c39be7600cc2d3d11239fba0bcdbccfc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5508, "upload_time": "2018-07-31T15:15:29", "url": "https://files.pythonhosted.org/packages/d7/ff/acb8039f49aafa9fda14cc40fa48b833e75b171fa87d5c2c1e32c92d95ff/directory_api_external-4.2.2-py3-none-any.whl" } ], "5.0.0": [ { "comment_text": "", "digests": { "md5": "997818027c59987ad9e6fb69d35f53cd", "sha256": "44356cdbd709831c7d8b2183b72402b032d9ece4cea1d91acd9cb039570a69ae" }, "downloads": -1, "filename": "directory_api_external-5.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "997818027c59987ad9e6fb69d35f53cd", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5025, "upload_time": "2018-10-30T17:03:08", "url": "https://files.pythonhosted.org/packages/dd/22/86a12ea19aae9ced4afc31fd4f934b80dc3f5f5fa0e896a52623ed4e028c/directory_api_external-5.0.0-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "997818027c59987ad9e6fb69d35f53cd", "sha256": "44356cdbd709831c7d8b2183b72402b032d9ece4cea1d91acd9cb039570a69ae" }, "downloads": -1, "filename": "directory_api_external-5.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "997818027c59987ad9e6fb69d35f53cd", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5025, "upload_time": "2018-10-30T17:03:08", "url": "https://files.pythonhosted.org/packages/dd/22/86a12ea19aae9ced4afc31fd4f934b80dc3f5f5fa0e896a52623ed4e028c/directory_api_external-5.0.0-py3-none-any.whl" } ] }