annofabapi.resource module

class annofabapi.resource.Resource(login_user_id: str, login_password: str, endpoint_url: str = 'https://annofab.com')[source]

AnnofabApi, Wrapperのインスタンスを保持するクラス

Parameters
  • login_user_id – AnnoFabにログインするときのユーザID

  • login_password – AnnoFabにログインするときのパスワード

  • endpoint_url – AnnoFab APIのエンドポイント。

api

AnnofabApi Instance

api2

AnnofabApi2 Instance

wrapper

Wrapper Instance

annofabapi.resource.build(login_user_id: Optional[str] = None, login_password: Optional[str] = None, endpoint_url: str = 'https://annofab.com')annofabapi.resource.Resource[source]

AnnofabApi, Wrapperのインスタンスを保持するインスタンスを生成する。

login_user_idlogin_password の両方がNoneの場合は、.netrc ファイルまたは環境変数から認証情報を取得する。 認証情報は、環境変数, .netrc ファイルの順に読み込む。

環境変数は``ANNOFAB_USER_ID`` , ANNOFAB_PASSWORD を参照する。

Parameters
  • login_user_id – AnnoFabにログインするときのユーザID

  • login_password – AnnoFabにログインするときのパスワード

  • endpoint_url – AnnoFab APIのエンドポイント。

Returns

AnnofabApi, Wrapperのインスタンスを保持するインスタンス

annofabapi.resource.build_from_env(endpoint_url: str = 'https://annofab.com')annofabapi.resource.Resource[source]

環境変数 ANNOFAB_USER_ID , ANNOFAB_PASSWORD から、annnofabapi.Resourceインスタンスを生成する。

Parameters

endpoint_url – AnnoFab APIのエンドポイント。

Returns

annnofabapi.Resourceインスタンス

annofabapi.resource.build_from_netrc(endpoint_url: str = 'https://annofab.com')annofabapi.resource.Resource[source]

.netrc ファイルから、annnofabapi.Resourceインスタンスを生成する。

Parameters

endpoint_url – AnnoFab APIのエンドポイント。

Returns

annnofabapi.Resourceインスタンス