atomscale.core.client#

Base client implementation and HTTP utilities.

Functions

canonical_workflow(workflow)

The unified name for a workflow that may still be addressed by a legacy one.

Classes

BaseClient(api_key, endpoint)

Base API client implementation

Exceptions

ClientError(message[, status_code, ...])

Generic error thrown by the Atomic Data Sciences API client
atomscale.core.client.canonical_workflow(workflow: str) → str[source]

The unified name for a workflow that may still be addressed by a legacy one.

Parameters:

workflow (str)

Return type:

str

class atomscale.core.client.BaseClient(api_key: str, endpoint: str)[source]

Bases: object

Base API client implementation

Parameters:

  • api_key (str | None)

  • endpoint (str)

  • api_key – API key.

  • endpoint – Root API endpoint.

property session

Session under which HTTP requests are issued

exception atomscale.core.client.ClientError(message: str, status_code: int | None = None, response_text: str | None = None)[source]

Bases: Exception

Generic error thrown by the Atomic Data Sciences API client

Parameters:

  • message (str)

  • status_code (int | None)

  • response_text (str | None)