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
Release files for directory-api-external 5.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| directory_api_external-5.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / directory_api_external-5.0.0-py3-none-any.whl
| Download URL | directory_api_external-5.0.0-py3-none-any.whl |
|---|---|
| Size | 5.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
44356cdbd709831c7d8b2183b72402b032d9ece4cea1d91acd9cb039570a69ae
|
|
BLAKE2b-256 checksum How to use checksums |
dd2286a12ea19aae9ced4afc31fd4f934b80dc3f5f5fa0e896a52623ed4e028c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
