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: str | None = None, login_password: str | None = None, endpoint_url: str = 'https://annofab.com') Resource [source]#
AnnofabApi, Wrapperのインスタンスを保持するインスタンスを生成する。
login_user_id
とlogin_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のインスタンスを保持するインスタンス
- Raises:
CredentialsNotFoundError – `.netrc`ファイルまたは環境変数にAnnofabの認証情報がなかった
- annofabapi.resource.build_from_env(endpoint_url: str = 'https://annofab.com') Resource [source]#
環境変数
ANNOFAB_USER_ID
,ANNOFAB_PASSWORD
から、annofabapi.Resourceインスタンスを生成する。- Parameters:
endpoint_url – Annofab APIのエンドポイント。
- Returns:
annofabapi.Resourceインスタンス
- Raises:
CredentialsNotFoundError – 環境変数にAnnofabの認証情報がなかった
- annofabapi.resource.build_from_netrc(endpoint_url: str = 'https://annofab.com') Resource [source]#
.netrc
ファイルから、annofabapi.Resourceインスタンスを生成する。- Parameters:
endpoint_url – Annofab APIのエンドポイント。
- Returns:
annofabapi.Resourceインスタンス
- Raises:
CredentialsNotFoundError – `.netrc`ファイルにAnnofabの認証情報がなかった