api-24sea 2.2.0__tar.gz → 2.3.0__tar.gz

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.
File without changes
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: api-24sea
3
- Version: 2.2.0
3
+ Version: 2.3.0
4
4
  Summary: Facilitate the users' interaction with the 24SEA API (https://api/24sea/eu) by providing pandas interfaces to the API endpoints.
5
5
  Author-email: Pietro D'Antuono <pietro.dantuono@24sea.eu>
6
6
  Maintainer-email: Pietro D'Antuono <pietro.dantuono@24sea.eu>
@@ -27,7 +27,7 @@ Requires-Dist: pydantic
27
27
  Requires-Dist: shorthand_datetime>=0.2.1,<1.0.0
28
28
  Requires-Dist: httpx>=0.28.0,<1.0.0
29
29
  Requires-Dist: tqdm>=4.65.0,<5.0.0
30
- Requires-Dist: api-24sea-ai>=0.1.0 ; extra == "ai"
30
+ Requires-Dist: api-24sea-ai>=0.2.0 ; extra == "ai"
31
31
  Requires-Dist: py-fatigue>=2.0.0 ; extra == "fatigue" and ( python_version>='3.10')
32
32
  Requires-Dist: py-fatigue>=1.0.0,<2.0.0 ; extra == "fatigue" and ( python_version<'3.10')
33
33
  Requires-Dist: swifter>=1.4.0 ; extra == "fatigue"
@@ -219,6 +219,9 @@ both, the metrics, and timestamps.
219
219
  - Timestamps: Timezone-aware datetime, strings in ISO 8601 format, or
220
220
  shorthand strings compatible with the [shorthand_datetime
221
221
  package](https://pypi.org/project/shorthand-datetime/).
222
+ - `method`: Optional HTTP method for the backend request. Default is
223
+ `GET`. Supported values are `GET`, `POST`, `PUT`, `PATCH`, and
224
+ `DELETE`.
222
225
 
223
226
  ``` python
224
227
  # %%
@@ -395,6 +398,9 @@ Therefore, the following combinations are possible:
395
398
  - Star schema as `dict[str, dict[str, Any]]`:
396
399
  `outer_join_on_timestamp` is irrelevant `as_star_schema=True`, and
397
400
  `as_dict=True`.
401
+ - `method`: Optional HTTP method for the backend request. Default is
402
+ `GET`. Supported values are `GET`, `POST`, `PUT`, `PATCH`, and
403
+ `DELETE`.
398
404
 
399
405
  ``` python
400
406
  # %%
@@ -179,6 +179,9 @@ both, the metrics, and timestamps.
179
179
  - Timestamps: Timezone-aware datetime, strings in ISO 8601 format, or
180
180
  shorthand strings compatible with the [shorthand_datetime
181
181
  package](https://pypi.org/project/shorthand-datetime/).
182
+ - `method`: Optional HTTP method for the backend request. Default is
183
+ `GET`. Supported values are `GET`, `POST`, `PUT`, `PATCH`, and
184
+ `DELETE`.
182
185
 
183
186
  ``` python
184
187
  # %%
@@ -355,6 +358,9 @@ Therefore, the following combinations are possible:
355
358
  - Star schema as `dict[str, dict[str, Any]]`:
356
359
  `outer_join_on_timestamp` is irrelevant `as_star_schema=True`, and
357
360
  `as_dict=True`.
361
+ - `method`: Optional HTTP method for the backend request. Default is
362
+ `GET`. Supported values are `GET`, `POST`, `PUT`, `PATCH`, and
363
+ `DELETE`.
358
364
 
359
365
  ``` python
360
366
  # %%
File without changes
@@ -144,6 +144,7 @@ class DataSignals:
144
144
  end_timestamp: Union[str, datetime.datetime],
145
145
  location: Optional[Union[List[str], str]] = None,
146
146
  force_cache_miss: bool = False,
147
+ method: str = "GET",
147
148
  ):
148
149
  """Get the data signals from the 24SEA API.
149
150
 
@@ -184,6 +185,7 @@ class DataSignals:
184
185
  as_dict=False,
185
186
  location=location,
186
187
  force_cache_miss=force_cache_miss,
188
+ method=method,
187
189
  )
188
190
 
189
191
  def as_dict(
@@ -310,6 +312,7 @@ class DataSignals:
310
312
  end_timestamp: Union[str, datetime.datetime],
311
313
  location: Optional[Union[List, str]] = None,
312
314
  force_cache_miss: bool = False,
315
+ method: str = "GET",
313
316
  ) -> Optional[
314
317
  Union[
315
318
  pd.DataFrame,
@@ -354,4 +357,5 @@ class DataSignals:
354
357
  end_timestamp=end_timestamp,
355
358
  location=location,
356
359
  force_cache_miss=force_cache_miss,
360
+ method=method,
357
361
  )