Rename Core to Client in Core

Author: Epse

src/obelisk/asynchronous/core.py

@@ -2,7 +2,7 @@
 This module contains the asynchronous API to interface with Obelisk CORE.
 These methods all return a :class:`Awaitable`.
 
-Relevant entrance points are :class:`Core`.
+Relevant entrance points are :class:`Client`.
 
 This API vaguely resembles that of clients to previous Obelisk versions,
 but also significantly diverts from it where the underlying Obelisk CORE API does so.
@@ -159,7 +159,7 @@ class QueryResult(BaseModel):
     items: List[Datapoint]
 
 
-class Core(BaseClient):
+class Client(BaseClient):
     page_limit: int = 250
     """How many datapoints to request per page in a cursored fetch"""
 

src/obelisk/types/core.py

@@ -1,11 +1,29 @@
+"""
+Types specific to Obelisk CORE, including an RSQL filter implementation
+
+To create a filter, look at :class:`Filter`.
+Example:
+
+>>> from datetime import datetime
+>>> f = (Filter().add_and(
+...     Comparison.equal('source', 'test source'),
+...     Comparison.is_in('metricType', ['number', 'number[]']),
+... ).add_or(
+...     Comparison.less('timestamp', datetime.fromtimestamp(1757422128))
+... ))
+>>> print(f)
+((('source'=='test source');('metricType'=in=('number', 'number[]'))),('timestamp'<'2025-09-09T14:48:48'))
+"""
 from __future__ import annotations
 from abc import ABC
 from datetime import datetime
 from typing import Any, Iterable, List
 
 
 FieldName = str # TODO: validate field names?
-"""https://obelisk.pages.ilabt.imec.be/obelisk-core/query.html#available-data-point-fields"""
+"""https://obelisk.pages.ilabt.imec.be/obelisk-core/query.html#available-data-point-fields
+Field names are not validated at this time, due to the inherent complexity.
+"""
 
 
 class Constraint(ABC):