vessel-api-python 2.1.1__py3-none-any.whl → 2.1.2__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.
@@ -1,6 +1,6 @@
1
1
  """Constants for the Vessel API Python SDK."""
2
2
 
3
- VERSION = "2.1.1"
3
+ VERSION = "2.1.2"
4
4
  DEFAULT_BASE_URL = "https://api.vesselapi.com/v1"
5
5
  DEFAULT_USER_AGENT = f"vesselapi-python/{VERSION}"
6
6
  DEFAULT_MAX_RETRIES = 3
@@ -54,8 +54,12 @@ class VesselAPIError(Exception):
54
54
  """True if the error is a 402 Payment Required response.
55
55
 
56
56
  Returned when a satellite-backed call is made with no satellite credits
57
- left. Retry without ``filter_sat`` to serve stored data instead, or top
58
- up the balance.
57
+ left. Retry without ``filter_sat`` to serve stored data instead.
58
+
59
+ .. deprecated::
60
+ The satellite fallback is withdrawn in its current form. From the
61
+ cutoff date ``filter_sat`` is ignored and no satellite request
62
+ returns 402.
59
63
  """
60
64
  return self.status_code == 402
61
65
 
@@ -75,7 +79,12 @@ class VesselAuthError(VesselAPIError):
75
79
 
76
80
 
77
81
  class VesselPaymentRequiredError(VesselAPIError):
78
- """Raised on 402 Payment Required responses (satellite credits exhausted)."""
82
+ """Raised on 402 Payment Required responses (satellite credits exhausted).
83
+
84
+ .. deprecated::
85
+ The satellite fallback is withdrawn in its current form. From the cutoff
86
+ date ``filter_sat`` is ignored and no satellite request returns 402.
87
+ """
79
88
 
80
89
 
81
90
  class VesselForbiddenError(VesselAPIError):
@@ -109,6 +109,13 @@ class VesselsService:
109
109
  sets how old a satellite fix may be and still be returned.
110
110
  ``filter_sat_max_age_minutes`` (15 to 4800, default 60, paid plans only) sets how
111
111
  old a stored position may be before a satellite lookup is made.
112
+
113
+ .. deprecated::
114
+ ``filter_sat``, ``filter_sat_lookback_minutes`` and
115
+ ``filter_sat_max_age_minutes`` are deprecated. The satellite fallback
116
+ is withdrawn in its current form. From the cutoff date in the
117
+ ``Sunset`` header they are accepted and ignored and no credit is
118
+ charged.
112
119
  """
113
120
  r = self._client.get(
114
121
  f"/vessel/{vessel_id}/position",
@@ -1593,6 +1600,13 @@ class AsyncVesselsService:
1593
1600
  sets how old a satellite fix may be and still be returned.
1594
1601
  ``filter_sat_max_age_minutes`` (15 to 4800, default 60, paid plans only) sets how
1595
1602
  old a stored position may be before a satellite lookup is made.
1603
+
1604
+ .. deprecated::
1605
+ ``filter_sat``, ``filter_sat_lookback_minutes`` and
1606
+ ``filter_sat_max_age_minutes`` are deprecated. The satellite fallback
1607
+ is withdrawn in its current form. From the cutoff date in the
1608
+ ``Sunset`` header they are accepted and ignored and no credit is
1609
+ charged.
1596
1610
  """
1597
1611
  r = await self._client.get(
1598
1612
  f"/vessel/{vessel_id}/position",
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: vessel-api-python
3
- Version: 2.1.1
3
+ Version: 2.1.2
4
4
  Summary: Python client for the Vessel Tracking API: maritime vessel tracking, port events, emissions, and nautical infrastructure.
5
5
  Project-URL: Documentation, https://vesselapi.com/docs
6
6
  Project-URL: Repository, https://github.com/vessel-api/vesselapi-python
@@ -131,9 +131,7 @@ print(f"{vessel.vessel.name} ({vessel.vessel.vessel_type})")
131
131
  pos = client.vessels.position("232003239", filter_id_type="mmsi")
132
132
  print(f"Position: {pos.vessel_position.latitude}, {pos.vessel_position.longitude}")
133
133
 
134
- # filter_sat=True falls back to satellite AIS when no recent terrestrial position is stored.
135
- # ⚠️ Satellite lookups draw on a prepaid balance and are charged per call.
136
- # Omit it unless you need that fallback.
134
+ # filter_sat is deprecated: the satellite fallback is withdrawn in its current form.
137
135
 
138
136
  # Find vessels with an AIS position within 10 km of Rotterdam in the last 2 hours
139
137
  # (the default time window, at most 4 hours).
@@ -142,6 +140,8 @@ for v in nearby.vessels or []:
142
140
  print(f"{v.vessel_name} at {v.latitude}, {v.longitude}")
143
141
  ```
144
142
 
143
+ > **Deprecated.** The satellite fallback is withdrawn in its current form. Requests with `filter.sat=true` keep working for existing credit holders until the cutoff date and carry Deprecation and Sunset headers. From the cutoff date the parameter is accepted and ignored, the response carries a Warning header, and no credit is charged. Credit packs are no longer on sale; unspent credits are refunded on request to support@vesselapi.com. The cutoff date is given in the `Sunset` header.
144
+
145
145
  ## Search
146
146
 
147
147
  `search.vessels` accepts `q`, a unified search across IMO, MMSI, ENI, callsign and
@@ -0,0 +1,13 @@
1
+ vessel_api_python/__init__.py,sha256=hUlZdyZGgArdYr8XJ30yQibkXXkQPqx3Y9zmVKvi6fc,3200
2
+ vessel_api_python/_client.py,sha256=L7qkzUiATDpPlxWViEKicNpNx7D90gCohas56uCimgA,4919
3
+ vessel_api_python/_constants.py,sha256=hQeGOGb1DbBATjUZlvglGx3THDLyuIArIGOPA4rfdpE,244
4
+ vessel_api_python/_errors.py,sha256=56Xh4AfzNw7K6LrIeRrpkTYXO-ox0pLSX_B_quSvAV0,6770
5
+ vessel_api_python/_iterator.py,sha256=SkgsGSdxLrKtw-ad8fSUPaEDDJCamAKK0PrG_P8HX-4,3198
6
+ vessel_api_python/_models.py,sha256=bvvd0yrK4Sa8rZ9ZTWRW2E9VedyInNDQm1NxdOCrbi0,21355
7
+ vessel_api_python/_services.py,sha256=eZA2Rj3OFpU-ULGHuB_Z8cOfB0ICXoUfkgnjeoaOQxE,110385
8
+ vessel_api_python/_transport.py,sha256=pfRaJwkq_GYpA5Ev8wH7tBdlzN2ykgy29Ag1L3F5K4Y,6956
9
+ vessel_api_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
10
+ vessel_api_python-2.1.2.dist-info/METADATA,sha256=mL0c5Tjc65ppQlApZZroYjJ_FS1SGjFOaihdU8ZmgvI,10514
11
+ vessel_api_python-2.1.2.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
12
+ vessel_api_python-2.1.2.dist-info/licenses/LICENSE,sha256=zoj_abq99mj8cz-Bz71XCnwB-Qv3kU1VzVXeKEntuQU,1067
13
+ vessel_api_python-2.1.2.dist-info/RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: hatchling 1.32.4
2
+ Generator: hatchling 1.33.0
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
@@ -1,13 +0,0 @@
1
- vessel_api_python/__init__.py,sha256=hUlZdyZGgArdYr8XJ30yQibkXXkQPqx3Y9zmVKvi6fc,3200
2
- vessel_api_python/_client.py,sha256=L7qkzUiATDpPlxWViEKicNpNx7D90gCohas56uCimgA,4919
3
- vessel_api_python/_constants.py,sha256=uYgcJuAHCdK1VA7SCknrl41TrRblNCsyXkTOwIAu3fY,244
4
- vessel_api_python/_errors.py,sha256=DaiyCjYKJZTo6-6sOqAcJBdOeFaIYgWHE48nsHWGeGA,6414
5
- vessel_api_python/_iterator.py,sha256=SkgsGSdxLrKtw-ad8fSUPaEDDJCamAKK0PrG_P8HX-4,3198
6
- vessel_api_python/_models.py,sha256=bvvd0yrK4Sa8rZ9ZTWRW2E9VedyInNDQm1NxdOCrbi0,21355
7
- vessel_api_python/_services.py,sha256=UOGpajcZAYrt03DfkG86nIR8zyCGwokq_qB4ZYit7BY,109699
8
- vessel_api_python/_transport.py,sha256=pfRaJwkq_GYpA5Ev8wH7tBdlzN2ykgy29Ag1L3F5K4Y,6956
9
- vessel_api_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
10
- vessel_api_python-2.1.1.dist-info/METADATA,sha256=-TbomFF0ihDCKicRL34-iCsPG9EUyuKuW6YX0G4cqp0,10153
11
- vessel_api_python-2.1.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
12
- vessel_api_python-2.1.1.dist-info/licenses/LICENSE,sha256=zoj_abq99mj8cz-Bz71XCnwB-Qv3kU1VzVXeKEntuQU,1067
13
- vessel_api_python-2.1.1.dist-info/RECORD,,