DDB Python Client

Vollständige Dokumentation des DDB Python -Clients, der den Zugriff auf die DDB -API mit Python vereinfacht.

Hinweis für externe Benutzer - Viele der Links im folgenden Abschnitt beziehen sich auf interne Anwendungen. Bitte sprechen Sie mit Ihrem Projektteam zur Unterstützung.

Voraussetzungen

• Benötigt Python 3.6+

Installation

Um die Pakete authentifizieren und herunterladen zu können, müssen Sie zunächst eine virtuelle Umgebung erstellen und einige Pakete installieren:

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

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

Anschließend müssen Sie in Ihrer virtuellen Umgebung eine "Pip.ini" (Windows) oder PIP.Conf (Mac/Linux) -Datei erstellen:

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

Sie können jeden Mikroservice mit PIP installieren:

pip install ddb-parameter-service

Avalierbare Mikrodienste

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

Sie benötigen auch unser Authentifizierungspaket, das Sie mit:

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

Hinweis: Dieses Paket sollte nur von "Scripters" verwendet werden, wenn Sie eine Bewerbung sind. Bitte stellen Sie sicher, dass Sie Ihr eigenes Zugriffs -Token generieren.

Importieren Sie dann die Microservice -API und -umgebungen aus dem Paket sowie die Authentifizierung:

from parameter_service import API, ENV
from DDBpy_auth import DDBAuth

Schritt für Schritt Anleitung

Wie man

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

response = parameter_service_client_instance.get_parameters()

Asynchrone Anrufe

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

Entwicklerinformationen

Das Repository befindet sich Hier (opens new window) . Sie können bevorstehende Änderungen am Paket sehen.