DDB Python Клиент

Полная документация клиента DDB Python, которая упрощает доступ к API DDB с использованием Python.

Примечание для внешних пользователей - Многие из ссылок в следующем разделе относятся к внутренним приложениям. Пожалуйста, поговорите с командой проекта для поддержки.

Предварительные условия

• Требуется Python 3.6+

Монтаж

Чтобы иметь возможность аутентификации и загрузки пакетов, вам сначала нужно будет создать виртуальную среду и установить несколько пакетов:

python -m venv .venv
.venv/Scripts/activate

python -m pip install --upgrade pip
pip install keyring artifacts-keyring

Затем вам нужно будет создать файл «pip.ini» (Windows) или Pip.conf (mac/linux) в вашей виртуальной среде со следующим контентом:

[global]
extra-index-url=https://ovearup.pkgs.visualstudio.com/_packaging/ddb/pypi/simple/

Вы можете установить каждое микросервис с помощью PIP:

pip install ddb-parameter-service

Доступные микросервисы

• ddb-comments-service

• ddb-environment-context-service

• ddb-parameter-metadata-service

• ddb-parameter-service

• ddb-qa-service

• ddb-reference-data-service

• ddb-user-service

Вам также понадобится наш пакет аутентификации, который вы можете установить, используя:

pip install git+https://github.com/arup-group/ddbpy_auth.git

ПРИМЕЧАНИЕ. Этот пакет должен использоваться только «скриптерами», если вы являетесь приложением, убедитесь, что вы создаете свой собственный токен доступа.

Затем импортируйте API и среды MicroService из пакета, а также аутентификацию:

from parameter_service import API, ENV
from DDBpy_auth import DDBAuth

Пошаговый гид

Как

parameter_service_client_instance = API(
 env = ENV.sandbox,
 token = DDBAuth.acquire_new_access_content()
)
response = parameter_service_client_instance.get_parameters()

Асинхронные звонки

parameter_service_client_instance = API(
 env = ENV.sandbox,
 token = DDBAuth.acquire_new_access_content(),
 pool_threads = 5
)
thread = parameter_service_client_instance.get_parameters(async_req=True)
response = thread.get()

Информация о разработчике

Репозиторий расположен здесь (opens new window) Полем Вы сможете увидеть предстоящие изменения в пакете.