Python API client for Export Directory.
Project description
directory-api-client-external
Export Directory external API client.
Installation
$ pip install directory-api-external
The api client expects the following settings:
| Setting | Notes |
|---|---|
| DIRECTORY_API_CLIENT_EXTERNAL_BASE_URL | |
| DIRECTORY_API_CLIENT_EXTERNAL_API_KEY | Unique to client. Retrieved during the on-boarding process. |
| DIRECTORY_API_CLIENT_EXTERNAL_SENDER_ID | Unique to client. Retrieved during the on-boarding process. |
| DIRECTORY_API_CLIENT_EXTERNAL_DEFAULT_TIMEOUT |
Once that is done the API client can be used:
from directory_api_external.client import api_client
Development
$ git clone https://github.com/uktrade/directory-api-client-external
$ cd directory-api-client-external
Publish to PyPI
The 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:
| Setting |
|---|
| DIRECTORY_PYPI_USERNAME |
| DIRECTORY_PYPI_PASSWORD |
Then run the following command:
make publish
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
File details
Details for the file directory_api_external-5.0.0-py3-none-any.whl.
File metadata
- Download URL: directory_api_external-5.0.0-py3-none-any.whl
- Upload date:
- Size: 5.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/38.7.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 44356cdbd709831c7d8b2183b72402b032d9ece4cea1d91acd9cb039570a69ae |
|
| MD5 | 997818027c59987ad9e6fb69d35f53cd |
|
| BLAKE2b-256 | dd2286a12ea19aae9ced4afc31fd4f934b80dc3f5f5fa0e896a52623ed4e028c |
