DDB Python クライアント

Python を使用して DDB API へのアクセスを簡素化する DDB Python クライアントの完全なドキュメント。

外部ユーザーにはメモ - 次のセクションのリンクの多くは、内部アプリケーションを参照してください。 サポートについては、プロジェクトチームに相談してください。

前提条件

• Python 3.6+が必要です

インストール

パッケージを認証してダウンロードできるようにするには、最初に仮想環境を作成し、いくつかのパッケージをインストールする必要があります。

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

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

次に、次のコンテンツを使用して、仮想環境で「pip.ini」または pip.conf（mac/linux）ファイルを作成する必要があります。

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

PIP を使用して各マイクロサービスをインストールできます。

pip install ddb-parameter-service

Avaliable 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

また、以下を使用してインストールできる認証パッケージも必要です。

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

注：このパッケージは、「スクリプター」がアプリケーションである場合にのみ使用する必要があります。独自のアクセストークンを生成していることを確認してください。

次に、パッケージからマイクロサービス API と環境を認証とインポートします。

from parameter_service import API, ENV
from DDBpy_auth import DDBAuth

ステップバイステップガイド

方法

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

response = parameter_service_client_instance.get_parameters()

非同期呼び出し

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

開発者情報

リポジトリはあります ここ (opens new window) 。 パッケージの今後の変更を確認できます。