Skip to main content

Python API client for Directory CMS.

Project description

directory-cms-client

circle-ci-image codecov-image pypi-image snyk-image

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.
DIRECTORY_CMS_API_CLIENT_CACHE_EXPIRE_SECONDS Duration to store the retrieved content in the cache

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]
$ pip install -r requirements_test.txt

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
directory_cms_client-8.2.0-py3-none-any.whl (7.8 kB) Copy SHA256 hash SHA256 Wheel py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page