DDB Python Client

Volledige documentatie van de DDB Python Client, die de toegang tot de DDB API vereenvoudigt met behulp van Python.

Opmerking voor externe gebruikers - Veel van de links in de volgende sectie verwijzen naar interne toepassingen. Praat alstublieft met uw projectteam voor ondersteuning.

Voorwaarden

• Vereist Python 3.6+

Installatie

Om de pakketten te authenticeren en te downloaden, moet u eerst een virtuele omgeving maken en een paar pakketten installeren:

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

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

U moet vervolgens een 'pip.ini' (Windows) of Pip.conf (Mac/Linux) -bestand in uw virtuele omgeving maken met de volgende inhoud:

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

U kunt elke microservice installeren met behulp van PIP:

pip install ddb-parameter-service

Avisable Microservices

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

U hebt ook ons authenticatiepakket nodig, dat u kunt installeren met behulp van:

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

OPMERKING: Dit pakket mag alleen worden gebruikt door "scripters" als u een applicatie bent, zorg er dan voor dat u uw eigen toegangstoken genereert.

Importeer vervolgens de Microservice API en omgevingen uit het pakket en de authenticatie:

from parameter_service import API, ENV
from DDBpy_auth import DDBAuth

Stap voor stap gids

Hoe

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

response = parameter_service_client_instance.get_parameters()

Asynchrone oproepen

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

Ontwikkelaarsinformatie

De repository is gelokaliseerd hier (opens new window) . U kunt aankomende wijzigingen in het pakket zien.