istsos4-client 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,47 @@
1
+ """Python client for istSOS4 (OGC SensorThings API)."""
2
+
3
+ __version__ = "0.1.0"
4
+
5
+ from .client import (
6
+ MAX_ROWS_PER_BULK,
7
+ OBSERVATION_COMPONENTS,
8
+ Client,
9
+ raise_for_status,
10
+ )
11
+ from .models import (
12
+ Datastream,
13
+ Entity,
14
+ FeatureOfInterest,
15
+ HistoricalLocation,
16
+ Location,
17
+ Network,
18
+ Observation,
19
+ ObservedProperty,
20
+ Policy,
21
+ Sensor,
22
+ Thing,
23
+ TimeInterval,
24
+ UnitOfMeasurement,
25
+ User,
26
+ )
27
+
28
+ __all__ = [
29
+ "MAX_ROWS_PER_BULK",
30
+ "OBSERVATION_COMPONENTS",
31
+ "Client",
32
+ "raise_for_status",
33
+ "Datastream",
34
+ "Entity",
35
+ "FeatureOfInterest",
36
+ "HistoricalLocation",
37
+ "Location",
38
+ "Network",
39
+ "Observation",
40
+ "ObservedProperty",
41
+ "Policy",
42
+ "Sensor",
43
+ "Thing",
44
+ "TimeInterval",
45
+ "UnitOfMeasurement",
46
+ "User",
47
+ ]
@@ -0,0 +1,38 @@
1
+ import time
2
+ import requests
3
+
4
+
5
+ class BearerTokenAuth:
6
+ """Bearer token authentication for istSOS4 client."""
7
+
8
+ def __init__(
9
+ self, url: str, username: str, password: str, leeway: int = 30
10
+ ):
11
+ self._token_url = url
12
+ self._user = username
13
+ self._pwd = password
14
+ self._leeway = leeway
15
+ self._token: str | None = None
16
+ self._expires_at: float = 0.0
17
+
18
+ def headers(self) -> dict[str, str]:
19
+ if (
20
+ self._token is None
21
+ or time.time() > self._expires_at - self._leeway
22
+ ):
23
+ self.refresh()
24
+ return {"Authorization": f"Bearer {self._token}"}
25
+
26
+ def refresh(self) -> None:
27
+ resp = requests.post(
28
+ self._token_url,
29
+ data={
30
+ "grant_type": "password",
31
+ "username": self._user,
32
+ "password": self._pwd,
33
+ },
34
+ )
35
+ resp.raise_for_status()
36
+ data = resp.json()
37
+ self._token = data["access_token"]
38
+ self._expires_at = time.time() + float(data["expires_in"])
@@ -0,0 +1,224 @@
1
+ from __future__ import annotations
2
+ from typing import Any, Iterator
3
+ from urllib.parse import quote, urlencode
4
+ import requests
5
+ from .models import Entity, Observation
6
+ from ._auth import BearerTokenAuth
7
+
8
+ OBSERVATION_COMPONENTS = [
9
+ "result",
10
+ "phenomenonTime",
11
+ "resultTime",
12
+ "resultQuality",
13
+ ]
14
+
15
+ # asyncpg rejects a statement with more than 32767 bound parameters. The server
16
+ # binds one parameter per component plus a handful of bookkeeping columns per
17
+ # row, so keep a single /BulkObservations request comfortably under the cap.
18
+ MAX_ROWS_PER_BULK = int(32767 * 0.9) // (len(OBSERVATION_COMPONENTS) + 8)
19
+
20
+
21
+ def raise_for_status(
22
+ response: requests.Response, context: str | None = None
23
+ ) -> None:
24
+ """requests' raise_for_status, with the server's error body in the message.
25
+
26
+ istSOS4 explains rejections in the response body (which datastream is
27
+ missing, which observation is a duplicate, ...); the default HTTPError
28
+ message drops it, so callers only ever see the status code.
29
+ """
30
+ try:
31
+ response.raise_for_status()
32
+ except requests.HTTPError as exc:
33
+ message = f"{context}: {exc}" if context else str(exc)
34
+ body = response.text.strip()
35
+ if body:
36
+ message = f"{message}; response body: {body}"
37
+ raise requests.HTTPError(
38
+ message, response=response, request=response.request
39
+ ) from exc
40
+
41
+
42
+ class Client:
43
+ """Client for an istSOS4 server instance."""
44
+
45
+ def __init__(
46
+ self,
47
+ base_url: str,
48
+ username: str | None = None,
49
+ password: str | None = None,
50
+ timeout: float = 30.0,
51
+ ):
52
+ self._base_url = base_url.rstrip("/")
53
+ self._auth = (
54
+ BearerTokenAuth(f"{self._base_url}/Login", username, password)
55
+ if username is not None
56
+ else None
57
+ )
58
+ self._timeout = timeout
59
+
60
+ @property
61
+ def base_url(self) -> str:
62
+ return self._base_url
63
+
64
+ def _headers(self, commit_message: str | None = None) -> dict[str, str]:
65
+ headers = self._auth.headers() if self._auth else {}
66
+ if commit_message:
67
+ headers["commit-message"] = commit_message
68
+ return headers
69
+
70
+ def post(self, entity: Entity, commit_message: str | None = None) -> int:
71
+ """Post an entity to the istSOS4 server."""
72
+ response = requests.post(
73
+ f"{self._base_url}{entity.ENDPOINT}",
74
+ json=entity.serialize(),
75
+ headers=self._headers(commit_message),
76
+ timeout=self._timeout,
77
+ )
78
+ raise_for_status(response, f"POST {entity.ENDPOINT}")
79
+ location = response.headers.get("Location")
80
+ if location:
81
+ entity.iot_id = int(location.rsplit("(", 1)[1].rstrip(")"))
82
+
83
+ return response.status_code
84
+
85
+ def get(self, entity: type[Entity], entity_id: int) -> Entity:
86
+ """Get an entity from the istSOS4 server."""
87
+ response = requests.get(
88
+ f"{self._base_url}{entity.ENDPOINT}/{entity_id}",
89
+ headers=self._headers(),
90
+ timeout=self._timeout,
91
+ )
92
+ raise_for_status(response, f"GET {entity.ENDPOINT}/{entity_id}")
93
+ return entity.model_validate(response.json())
94
+
95
+ def iter_list(
96
+ self,
97
+ entity: type[Entity],
98
+ filter: str | None = None,
99
+ select: str | None = None,
100
+ orderby: str | None = None,
101
+ expand: str | None = None,
102
+ top: int | None = None,
103
+ ) -> Iterator[Entity]:
104
+ """Yield entities one page at a time, following @iot.nextLink.
105
+
106
+ Use this instead of `list()` for collections too large to hold in
107
+ memory (observation histories, migrations, ...).
108
+
109
+ Query options are passed through as OData parameters, e.g.
110
+ filter="phenomenonTime ge 2026-01-01T00:00:00Z".
111
+ """
112
+ params: dict[str, str | int] = {
113
+ f"${key}": value
114
+ for key, value in dict(
115
+ filter=filter,
116
+ select=select,
117
+ orderby=orderby,
118
+ expand=expand,
119
+ top=top,
120
+ ).items()
121
+ if value is not None
122
+ }
123
+ url: str | None = f"{self._base_url}{entity.ENDPOINT}"
124
+ if params:
125
+ # requests encodes spaces as '+' by default; OData servers expect
126
+ # %20. safe="$" keeps the OData $filter/$top keys literal.
127
+ url = f"{url}?{urlencode(params, safe='$', quote_via=quote)}"
128
+ while url:
129
+ response = requests.get(
130
+ url,
131
+ headers=self._headers(),
132
+ timeout=self._timeout,
133
+ )
134
+ raise_for_status(response, f"GET {url}")
135
+ data = response.json()
136
+ for item in data.get("value", []):
137
+ yield entity.model_validate(item)
138
+ url = data.get("@iot.nextLink")
139
+
140
+ def list(self, entity: type[Entity], **query: Any) -> list[Entity]:
141
+ """List all entities of a given type from the istSOS4 server.
142
+
143
+ Accepts the same query options as `iter_list()`.
144
+ """
145
+ return list(self.iter_list(entity, **query))
146
+
147
+ def patch(self, entity: Entity, commit_message: str | None = None) -> int:
148
+ """Patch an entity on the istSOS4 server.
149
+
150
+ Only the fields that are set are sent, so a partial update is just a
151
+ partly-filled entity: Observation(iot_id=7, result=1.5).
152
+ """
153
+ if entity.iot_id is None:
154
+ raise ValueError(
155
+ f"Cannot patch {entity.__class__.__name__} without an iot_id. Please ensure the entity has been created and has a valid iot_id."
156
+ )
157
+ response = requests.patch(
158
+ f"{self._base_url}{entity.ENDPOINT}/{entity.iot_id}",
159
+ json=entity.serialize(),
160
+ headers=self._headers(commit_message),
161
+ timeout=self._timeout,
162
+ )
163
+ raise_for_status(
164
+ response, f"PATCH {entity.ENDPOINT}({entity.iot_id})"
165
+ )
166
+ return response.status_code
167
+
168
+ def bulk_observations(
169
+ self,
170
+ observations: list[Observation],
171
+ commit_message: str | None = None,
172
+ ) -> int:
173
+ """Post observations to /BulkObservations, one dataArray per Datastream.
174
+
175
+ Returns the number of observations sent. Requests are split so a single
176
+ one never exceeds the server's parameter limit; duplicates are not
177
+ filtered out, so the server rejects a batch that repeats a
178
+ phenomenonTime already stored for the datastream.
179
+ """
180
+ if not observations:
181
+ raise ValueError("The observations list is empty.")
182
+ rows_by_datastream: dict[int, list[list[Any]]] = {}
183
+ for observation in observations:
184
+ datastream = observation.datastream
185
+ datastream_id = (
186
+ datastream.iot_id
187
+ if isinstance(datastream, Entity)
188
+ else datastream
189
+ )
190
+ if datastream_id is None:
191
+ raise ValueError(
192
+ "Each observation needs a datastream with an id."
193
+ )
194
+ row = observation.serialize()
195
+ if "phenomenonTime" not in row:
196
+ raise ValueError("Each observation needs a phenomenonTime.")
197
+ rows_by_datastream.setdefault(datastream_id, []).append(
198
+ [
199
+ row.get("result"),
200
+ row["phenomenonTime"],
201
+ row.get("resultTime", row["phenomenonTime"]),
202
+ row.get("resultQuality"),
203
+ ]
204
+ )
205
+
206
+ sent = 0
207
+ for datastream_id, rows in rows_by_datastream.items():
208
+ for offset in range(0, len(rows), MAX_ROWS_PER_BULK):
209
+ batch = rows[offset : offset + MAX_ROWS_PER_BULK]
210
+ response = requests.post(
211
+ f"{self._base_url}/BulkObservations",
212
+ json=[
213
+ {
214
+ "Datastream": {"@iot.id": datastream_id},
215
+ "components": OBSERVATION_COMPONENTS,
216
+ "dataArray": batch,
217
+ }
218
+ ],
219
+ headers=self._headers(commit_message),
220
+ timeout=self._timeout,
221
+ )
222
+ raise_for_status(response, "POST /BulkObservations")
223
+ sent += len(batch)
224
+ return sent
@@ -0,0 +1,237 @@
1
+ from datetime import datetime
2
+ from typing import Any, ClassVar
3
+
4
+ from pydantic import (
5
+ BaseModel,
6
+ ConfigDict,
7
+ Field,
8
+ field_serializer,
9
+ model_serializer,
10
+ model_validator,
11
+ )
12
+ from pydantic.alias_generators import to_camel
13
+
14
+
15
+ class TimeInterval(BaseModel):
16
+ """SensorThings encodes time ranges as 'startISO/endISO' strings."""
17
+
18
+ start: datetime
19
+ end: datetime
20
+
21
+ @model_validator(mode="before")
22
+ @classmethod
23
+ def _split_iso_pair(cls, v: Any) -> Any:
24
+ if isinstance(v, str):
25
+ start, end = v.split("/", 1)
26
+ return {"start": start, "end": end}
27
+ return v
28
+
29
+ @model_serializer
30
+ def _join_iso_pair(self) -> str:
31
+ return f"{self.start.isoformat()}/{self.end.isoformat()}"
32
+
33
+
34
+ class UnitOfMeasurement(BaseModel):
35
+ name: str | None = None
36
+ symbol: str | None = None
37
+ definition: str | None = None
38
+
39
+
40
+ # ---------------------------------------------------------------------------
41
+ # Base
42
+ # ---------------------------------------------------------------------------
43
+
44
+
45
+ class Entity(BaseModel):
46
+ """Common base — the istSOSComponent."""
47
+
48
+ model_config = ConfigDict(
49
+ populate_by_name=True, # Python code uses snake_case names
50
+ extra="ignore", # nav links, versioning fields, ... dropped
51
+ alias_generator=to_camel, # phenomenon_time <-> phenomenonTime
52
+ )
53
+
54
+ ENDPOINT: ClassVar[str]
55
+
56
+ # Read-only server fields: parsed from GETs, never sent back.
57
+ iot_id: int | None = Field(None, alias="@iot.id", exclude=True)
58
+ self_link: str | None = Field(None, alias="@iot.selfLink", exclude=True)
59
+
60
+ def serialize(self) -> dict[str, Any]:
61
+ return self.model_dump(mode="json", by_alias=True, exclude_none=True)
62
+
63
+ @classmethod
64
+ def deserialize(cls, data: dict[str, Any]) -> "Entity":
65
+ return cls.model_validate(data)
66
+
67
+
68
+ def _link_or_embed(value: Any) -> Any:
69
+ """How relation fields serialize:
70
+ 42 -> {"@iot.id": 42} shallow link
71
+ Entity with iot_id set -> {"@iot.id": ...} shallow link (reuse!)
72
+ Entity without iot_id -> nested JSON deep insert
73
+ """
74
+ if isinstance(value, int):
75
+ return {"@iot.id": value}
76
+ if isinstance(value, Entity):
77
+ if value.iot_id is not None:
78
+ return {"@iot.id": value.iot_id}
79
+ return value.serialize()
80
+ return value
81
+
82
+
83
+ # ---------------------------------------------------------------------------
84
+ # istSOS4 admin entities (NOT SensorThings — different JSON envelope)
85
+ # ---------------------------------------------------------------------------
86
+
87
+
88
+ class User(Entity):
89
+ """{"id": 1, "username": "admin", "contact": null,
90
+ "uri": "/Users(1)", "role": "administrator"}"""
91
+
92
+ ENDPOINT: ClassVar[str] = "/Users"
93
+
94
+ iot_id: int | None = Field(None, alias="id", exclude=True)
95
+ username: str
96
+ contact: str | None = None
97
+ uri: str | None = None
98
+ role: str
99
+
100
+
101
+ class Policy(Entity):
102
+ ENDPOINT: ClassVar[str] = "/Policies"
103
+
104
+ schemaname: str
105
+ tablename: str
106
+ policyname: str
107
+ permissive: str
108
+ roles: list[str]
109
+ cmd: str
110
+ qual: str = "true"
111
+ with_check: str = Field("true", alias="with_check")
112
+
113
+
114
+ # ---------------------------------------------------------------------------
115
+ # SensorThings entities + Network
116
+ # ---------------------------------------------------------------------------
117
+
118
+
119
+ class Network(Entity):
120
+ ENDPOINT: ClassVar[str] = "/Networks"
121
+
122
+ name: str
123
+
124
+
125
+ class Location(Entity):
126
+ ENDPOINT: ClassVar[str] = "/Locations"
127
+
128
+ name: str
129
+ description: str
130
+ encoding_type: str = "application/json"
131
+ location: dict[str, Any]
132
+ properties: dict[str, Any] | None = None
133
+
134
+
135
+ class Thing(Entity):
136
+ ENDPOINT: ClassVar[str] = "/Things"
137
+
138
+ name: str
139
+ description: str
140
+ properties: dict[str, Any] | None = None
141
+ locations: list[int | Location] | None = Field(None, alias="Locations")
142
+
143
+ @field_serializer("locations")
144
+ def _rel(self, v: Any) -> Any:
145
+ return v if v is None else [_link_or_embed(item) for item in v]
146
+
147
+
148
+ class HistoricalLocation(Entity):
149
+ """Server-generated when a Thing's Locations change; read-mostly.
150
+ Relations modelled so $expand=Thing,Locations deserializes into
151
+ typed objects instead of being silently dropped."""
152
+
153
+ ENDPOINT: ClassVar[str] = "/HistoricalLocations"
154
+
155
+ time: datetime
156
+ thing: int | Thing | None = Field(None, alias="Thing")
157
+ locations: list[int | Location] | None = Field(None, alias="Locations")
158
+
159
+ @field_serializer("thing")
160
+ def _rel_one(self, v: Any) -> Any:
161
+ return _link_or_embed(v)
162
+
163
+ @field_serializer("locations")
164
+ def _rel_many(self, v: Any) -> Any:
165
+ return v if v is None else [_link_or_embed(item) for item in v]
166
+
167
+
168
+ class Sensor(Entity):
169
+ ENDPOINT: ClassVar[str] = "/Sensors"
170
+
171
+ name: str
172
+ description: str | None = None
173
+ encoding_type: str
174
+ metadata: str | None = None
175
+ properties: dict[str, Any] | None = None
176
+
177
+
178
+ class ObservedProperty(Entity):
179
+ ENDPOINT: ClassVar[str] = "/ObservedProperties"
180
+
181
+ name: str
182
+ description: str
183
+ definition: str
184
+ properties: dict[str, Any] | None = None
185
+
186
+
187
+ class Datastream(Entity):
188
+ ENDPOINT: ClassVar[str] = "/Datastreams"
189
+
190
+ name: str
191
+ description: str
192
+ unit_of_measurement: UnitOfMeasurement
193
+ observation_type: str
194
+ properties: dict[str, Any] | None = None
195
+ observed_area: dict[str, Any] | None = Field(None, exclude=True)
196
+ phenomenon_time: TimeInterval | None = Field(None, exclude=True)
197
+ result_time: TimeInterval | None = Field(None, exclude=True)
198
+ thing: int | Thing | None = Field(None, alias="Thing")
199
+ sensor: int | Sensor | None = Field(None, alias="Sensor")
200
+ observed_property: int | ObservedProperty | None = Field(
201
+ None, alias="ObservedProperty"
202
+ )
203
+ network: int | Network | None = Field(None, alias="Network")
204
+
205
+ @field_serializer("thing", "sensor", "observed_property", "network")
206
+ def _rel(self, v: Any) -> Any:
207
+ return _link_or_embed(v)
208
+
209
+
210
+ class FeatureOfInterest(Entity):
211
+ ENDPOINT: ClassVar[str] = "/FeaturesOfInterest"
212
+
213
+ name: str
214
+ description: str
215
+ encoding_type: str = "application/json"
216
+ feature: dict[str, Any]
217
+ properties: dict[str, Any] | None = None
218
+
219
+
220
+ class Observation(Entity):
221
+ ENDPOINT: ClassVar[str] = "/Observations"
222
+
223
+ # Optional so a partial entity can be PATCHed: Observation(iot_id=7, result=1.5)
224
+ phenomenon_time: datetime | TimeInterval | None = None
225
+ result: Any = None
226
+ result_time: datetime | None = None
227
+ result_quality: Any = None
228
+ valid_time: TimeInterval | None = None
229
+ parameters: dict[str, Any] | None = None
230
+ datastream: int | Datastream | None = Field(None, alias="Datastream")
231
+ feature_of_interest: int | FeatureOfInterest | None = Field(
232
+ None, alias="FeatureOfInterest"
233
+ )
234
+
235
+ @field_serializer("datastream", "feature_of_interest")
236
+ def _rel(self, v: Any) -> Any:
237
+ return _link_or_embed(v)
File without changes
@@ -0,0 +1,209 @@
1
+ Metadata-Version: 2.5
2
+ Name: istsos4-client
3
+ Version: 0.1.0
4
+ Summary: Python client for istSOS4 (OGC SensorThings API)
5
+ Project-URL: Homepage, https://github.com/istSOS/istSOS4-client
6
+ Project-URL: Repository, https://github.com/istSOS/istSOS4-client
7
+ Project-URL: Issues, https://github.com/istSOS/istSOS4-client/issues
8
+ Author-email: Alessandro Centazzo <centazzoda@gmail.com>
9
+ License-Expression: Apache-2.0
10
+ License-File: LICENSE
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Programming Language :: Python :: 3.13
18
+ Classifier: Topic :: Scientific/Engineering :: GIS
19
+ Requires-Python: >=3.10
20
+ Requires-Dist: pydantic>=2.0
21
+ Requires-Dist: requests>=2.28
22
+ Description-Content-Type: text/markdown
23
+
24
+ # istsos4-client
25
+
26
+ Python client for [istSOS4](https://github.com/istSOS/istsos4) (OGC SensorThings API).
27
+
28
+ ## Installation
29
+
30
+ ```bash
31
+ pip install istsos4-client
32
+ ```
33
+
34
+ Requires Python 3.10+.
35
+
36
+ ## Usage
37
+
38
+ ### Connect
39
+
40
+ ```python
41
+ from istsos4_client import Client
42
+
43
+ client = Client("http://localhost:8018/istsos4/v1.1")
44
+ ```
45
+
46
+ With authentication (logs in at `<base_url>/Login`):
47
+
48
+ ```python
49
+ client = Client(
50
+ "http://localhost:8018/istsos4/v1.1",
51
+ username="admin",
52
+ password="admin",
53
+ )
54
+ ```
55
+
56
+ The bearer token is fetched and refreshed automatically.
57
+
58
+ ### Create entities
59
+
60
+ ```python
61
+ from istsos4_client import (
62
+ Thing, Sensor, ObservedProperty, Datastream,
63
+ UnitOfMeasurement, Observation,
64
+ )
65
+
66
+ thing = Thing(name="Weather station", description="Station on the roof")
67
+ client.post(thing) # thing.iot_id is set from the response
68
+
69
+ sensor = Sensor(name="DHT22", encoding_type="application/pdf")
70
+ client.post(sensor)
71
+
72
+ obs_prop = ObservedProperty(
73
+ name="Air temperature",
74
+ description="Temperature of the air",
75
+ definition="http://vocab.nerc.ac.uk/collection/P07/current/CFSN0023/",
76
+ )
77
+ client.post(obs_prop)
78
+
79
+ datastream = Datastream(
80
+ name="Air temperature at roof",
81
+ description="Temperature readings",
82
+ unit_of_measurement=UnitOfMeasurement(name="degree Celsius", symbol="°C"),
83
+ observation_type="http://www.opengis.net/def/observationType/OGC-OM/2.0/OM_Measurement",
84
+ thing=thing, # linked by @iot.id since thing.iot_id is set
85
+ sensor=sensor,
86
+ observed_property=obs_prop,
87
+ )
88
+ client.post(datastream)
89
+ ```
90
+
91
+ Relations accept an `int` id, an entity that was already posted (linked by
92
+ id), or an unsaved entity (deep insert):
93
+
94
+ ```python
95
+ # Deep insert: creates the Thing together with the Datastream
96
+ datastream = Datastream(
97
+ ...,
98
+ thing=Thing(name="New station", description="Created inline"),
99
+ )
100
+ ```
101
+
102
+ ### Post observations
103
+
104
+ ```python
105
+ from datetime import datetime, timezone
106
+
107
+ obs = Observation(
108
+ phenomenon_time=datetime.now(timezone.utc),
109
+ result=21.3,
110
+ datastream=datastream,
111
+ )
112
+ client.post(obs)
113
+ ```
114
+
115
+ istSOS4 supports commit messages for traceability:
116
+
117
+ ```python
118
+ client.post(obs, commit_message="Nightly import from field logger")
119
+ ```
120
+
121
+ Batches go to `/BulkObservations` as one `dataArray` per datastream, split
122
+ into as many requests as the server's row limit needs. Returns how many
123
+ observations were sent:
124
+
125
+ ```python
126
+ sent = client.bulk_observations([obs1, obs2, obs3])
127
+ ```
128
+
129
+ ### Read entities
130
+
131
+ ```python
132
+ # Single entity by id
133
+ thing = client.get(Thing, 1)
134
+
135
+ # All entities of a type (pagination via @iot.nextLink handled automatically)
136
+ things = client.list(Thing)
137
+ observations = client.list(Observation)
138
+
139
+ # Same query options, streamed a page at a time — for collections too large
140
+ # to hold in memory
141
+ for obs in client.iter_list(Observation, orderby="phenomenonTime"):
142
+ ...
143
+ ```
144
+
145
+ ### Filter queries
146
+
147
+ `list()` passes OData query options straight to the server:
148
+
149
+ ```python
150
+ observations = client.list(
151
+ Observation,
152
+ filter="phenomenonTime ge 2026-07-01T00:00:00Z and result gt 20",
153
+ orderby="phenomenonTime",
154
+ )
155
+ ```
156
+
157
+ Supported options: `filter`, `select`, `orderby`, `expand`, `top`.
158
+ Field names in query strings use the server's camelCase form
159
+ (`phenomenonTime`, not `phenomenon_time`). Note that `select` must keep
160
+ the fields the model requires, and `top` sets the server page size —
161
+ `list()` still follows pagination and returns all matches.
162
+
163
+ ### Update entities
164
+
165
+ ```python
166
+ thing = client.get(Thing, 1)
167
+ thing.description = "Moved to the north side of the roof"
168
+ client.patch(thing) # requires iot_id, set by get()/post()
169
+ ```
170
+
171
+ Only the fields that are set are sent, so a partial update needs no read:
172
+
173
+ ```python
174
+ client.patch(Observation(iot_id=7, result=1.5, result_quality="100"))
175
+ ```
176
+
177
+ ### Errors
178
+
179
+ `get`, `list`, `post`, `patch` and `bulk_observations` raise
180
+ `requests.HTTPError` on a non-2xx response, with the server's error body in
181
+ the message and the response itself on `exc.response`.
182
+
183
+ ### Time intervals
184
+
185
+ `phenomenonTime` ranges use the SensorThings `start/end` ISO string encoding,
186
+ exposed as a typed object:
187
+
188
+ ```python
189
+ from istsos4_client import TimeInterval
190
+
191
+ obs = Observation(
192
+ phenomenon_time=TimeInterval(
193
+ start=datetime(2026, 7, 1, tzinfo=timezone.utc),
194
+ end=datetime(2026, 7, 2, tzinfo=timezone.utc),
195
+ ),
196
+ result=20.1,
197
+ datastream=42, # plain int id works too
198
+ )
199
+ ```
200
+
201
+ ### Available entities
202
+
203
+ `Thing`, `Location`, `HistoricalLocation`, `Sensor`, `ObservedProperty`,
204
+ `Datastream`, `FeatureOfInterest`, `Observation`, plus istSOS4-specific
205
+ `Network`, `User`, and `Policy`.
206
+
207
+ ## License
208
+
209
+ Apache-2.0
@@ -0,0 +1,9 @@
1
+ istsos4_client/__init__.py,sha256=miwvMBR2PFX0XzW85bW9U8ZVnGKS4YsDU4LhyvKTK1M,803
2
+ istsos4_client/_auth.py,sha256=rS3K0DvGgZay8WFgwQDIbHlvvMR1mEwS9mBhZDAQQJI,1073
3
+ istsos4_client/client.py,sha256=VacDNUMBQfwWJIDLebOyb1iVsnobG9FwJpKaHRfHgmc,8375
4
+ istsos4_client/models.py,sha256=rgHUAMIq3JsU1cRAQIz9BgJIa2vuGXPbKgqnpis4zvs,6949
5
+ istsos4_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
6
+ istsos4_client-0.1.0.dist-info/METADATA,sha256=iNkH2cAjAtgKsHvSN-mlCv8nUmy0g77_DepR93DD3o0,5559
7
+ istsos4_client-0.1.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
8
+ istsos4_client-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
9
+ istsos4_client-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.32.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.