Client DDB Python

Documentation complète du client DDB Python, qui simplifie l'accès à l'API DDB à l'aide de Python.

Remarque pour les utilisateurs externes - De nombreux liens de la section suivante se réfèrent aux applications internes. Veuillez parler à votre équipe de projet pour obtenir un soutien.

Conditions préalables

• Nécessite Python 3.6+

Installation

Pour pouvoir authentifier et télécharger les packages, vous devrez d'abord créer un environnement virtuel et installer quelques packages:

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

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

Vous devrez alors créer un fichier 'Pip.ini' (Windows) ou pip.conf (Mac / Linux) dans votre environnement virtuel avec le contenu suivant:

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

Vous pouvez installer chaque microservice à l'aide de PIP:

pip install ddb-parameter-service

Microservices avaliables

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

Vous aurez également besoin du package d'authentification, que vous pouvez installer en utilisant:

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

Remarque: Ce package ne doit être utilisé que par "Scripters" si vous êtes une application, veuillez vous assurer que vous générez votre propre jeton d'accès.

Importez ensuite l'API et les environnements Microservice à partir du package ainsi que l'authentification:

from parameter_service import API, ENV
from DDBpy_auth import DDBAuth

Guide étape par étape

Comment

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

response = parameter_service_client_instance.get_parameters()

Appels asynchrones

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

Informations sur les développeurs

Le référentiel est situé ici (opens new window) . Vous pourrez voir les modifications à venir dans le package.