directory-cms-client
Directory CMS client.
Client for the Directory Content Management read-only API.
Installation
$ pip install directory-cms-client
The api client expects the following settings:
| Setting | Notes |
|---|---|
| DIRECTORY_CMS_API_CLIENT_BASE_URL | |
| DIRECTORY_CMS_API_CLIENT_API_KEY | Unique to client. Retrieved during the on-boarding process. |
| DIRECTORY_CMS_API_CLIENT_SENDER_ID | Unique to client. Retrieved during the on-boarding process. |
| DIRECTORY_CMS_API_CLIENT_DEFAULT_TIMEOUT | |
| DIRECTORY_CMS_API_CLIENT_SERVICE_NAME | Unique to client, can be hardcoded. |
The following directory client core settings also apply to directory cms client:
| Setting | Notes |
|---|---|
| DIRECTORY_CLIENT_CORE_CACHE_EXPIRE_SECONDS | Duration to store the retrieved content in the cache. |
| DIRECTORY_CLIENT_CORE_CACHE_LOG_THROTTLING_SECONDS | Duration to throttle log events for a given url for. |
And also specify a cache with name cms_fallback:
CACHES = {
'cms_fallback': ...
}
Once that is done the API client can be used:
from directory_api_client.client import cms_api_client
Development
$ git clone https://github.com/uktrade/directory-cms-client
$ cd directory-cms-client
$ [create virtual environment and activate]
$ make test_requirements
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-cms-client 12.3.4
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_cms_client-12.3.4-py3-none-any.whl | Python 3 | none | any | Details |
Release files / directory_cms_client-12.3.4-py3-none-any.whl
| Download URL | directory_cms_client-12.3.4-py3-none-any.whl |
|---|---|
| Size | 8.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a140213927083fbd66d40b8877f6818ec6698e09bb50c736e18fd86a8137eafa
|
|
BLAKE2b-256 checksum How to use checksums |
5cd69a91a0d55151ba28aca896e26f4545e7c7f7575f27ed16c43a7fc01331a2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.9.13
|
