obelisk.asynchronous.core.Client

class obelisk.asynchronous.core.Client(client: str, secret: str, retry_strategy: ~obelisk.strategies.retry.RetryStrategy = <obelisk.strategies.retry.NoRetryStrategy object>, kind: ~obelisk.types.ObeliskKind = ObeliskKind.CLASSIC)[source]

Bases: BaseClient

__init__(client: str, secret: str, retry_strategy: ~obelisk.strategies.retry.RetryStrategy = <obelisk.strategies.retry.NoRetryStrategy object>, kind: ~obelisk.types.ObeliskKind = ObeliskKind.CLASSIC) None

Methods

async fetch_single_chunk(params: QueryParams) QueryResult[source]
async query(params: QueryParams) List[Dict[str, Any]][source]
async query_time_chunked(params: ChunkedParams) AsyncIterator[List[Dict[str, Any]]][source]
async send(dataset: str, data: List[IncomingDatapoint]) Response[source]

Publishes data to Obelisk

Parameters

datasetstr

ID for the dataset to publish to

dataList[IncomingDatapoint]

List of Obelisk-acceptable datapoints. Exact format varies between Classic or HFS, caller is responsible for formatting.

Raises

ObeliskError

When the resulting status code is not 204, an ObeliskError is raised.

Attributes

page_limit: int = 250

How many datapoints to request per page in a cursored fetch

retry_strategy: RetryStrategy
kind: ObeliskKind
log: logging.Logger