Cliente DDB Python

Documentación completa del cliente DDB Python, que simplifica el acceso a la API DDB usando Python.

Nota para usuarios externos - Muchos de los enlaces en la siguiente sección se refieren a aplicaciones internas. Hable con su equipo de proyecto para obtener apoyo.

Requisitos previos

• Requiere Python 3.6+

Instalación

Para poder autenticar y descargar los paquetes, primero deberá crear un entorno virtual e instalar algunos paquetes:

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

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

Luego deberá crear un archivo 'Pip.ini' (Windows) o Pip.Conf (Mac/Linux) en su entorno virtual con el siguiente contenido:

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

Puede instalar cada microservicio con PIP:

pip install ddb-parameter-service

Microservicios avalables

• ddb-comments-service
• ddb-environment-context-service
• ddb-parameter-metadata-service
• ddb-parameter-service
• ddb-qa-service
• ddb-reference-data-service
• ddb-user-service
• ddb-template-service

También necesitará nuestro paquete de autenticación, que puede instalar utilizando:

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

Nota: Este paquete solo debe ser utilizado por "Scripters" si es una aplicación, asegúrese de generar su propio token de acceso.

Luego importe la API y los entornos de microservicio desde el paquete, así como la autenticación:

from parameter_service import API, ENV
from DDBpy_auth import DDBAuth

Guía paso por paso

Cómo

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

response = parameter_service_client_instance.get_parameters()

Llamadas asíncronas

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()

Información del desarrollador

El repositorio se encuentra aquí (opens new window) . Podrá ver los próximos cambios en el paquete.