DDB Python klient

Fuld dokumentation af DDB Python klient, der forenkler adgangen til DDB API ved hjælp af Python.

Bemærk til eksterne brugere - Mange af linkene i det følgende afsnit henviser til interne applikationer. Tal venligst til dit projektteam for support.

Forudsætninger

• Kræver Python 3.6+

Installation

For at være i stand til at autentificere og downloade pakkerne, skal du først oprette et virtuelt miljø og installere et par pakker:

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

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

Derefter skal du oprette en 'pip.ini' (Windows) eller Pip.Conf (Mac/Linux) -fil i dit virtuelle miljø med følgende indhold:

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

Du kan installere hver mikroservice ved hjælp af PIP:

pip install ddb-parameter-service

Tilgængelige mikroservices

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

Du har også brug for vores godkendelsespakke, som du kan installere ved hjælp af:

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

Bemærk: Denne pakke skal kun bruges af "scripters", hvis du er en applikation, skal du sikre dig, at du genererer dit eget adgangstoken.

Importer derefter Microservice API og miljøer fra pakken såvel som godkendelsen:

from parameter_service import API, ENV
from DDBpy_auth import DDBAuth

Trin for trin guide

Hvordan

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

response = parameter_service_client_instance.get_parameters()

Asynkrone opkald

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

Udviklerinformation

Repositoriet er placeret her (opens new window) . Du kan se kommende ændringer i pakken.