vessel-api-python 2.1.0__py3-none-any.whl → 2.1.1__py3-none-any.whl

vessel_api_python/_constants.py

@@ -1,6 +1,6 @@
 """Constants for the Vessel API Python SDK."""
 
-VERSION = "2.1.0"
+VERSION = "2.1.1"
 DEFAULT_BASE_URL = "https://api.vesselapi.com/v1"
 DEFAULT_USER_AGENT = f"vesselapi-python/{VERSION}"
 DEFAULT_MAX_RETRIES = 3

vessel_api_python/_models.py

@@ -127,7 +127,11 @@ class VesselResponse(_Base):
 
 
 class VesselPosition(_Base):
-    """A real-time vessel position record from AIS data."""
+    """A real-time vessel position record from AIS data.
+
+    ``suspected_glitch`` is true when the move from the previous clean report
+    implies a speed over 500 knots.
+    """
 
     cog: float | None = None
     heading: int | None = None
@@ -145,7 +149,7 @@ class VesselPosition(_Base):
 
 
 class PreviousPosition(_Base):
-    """The vessel's newest position report before the served one."""
+    """The vessel's newest position report before the returned one."""
 
     latitude: float | None = None
     longitude: float | None = None
@@ -153,9 +157,14 @@ class PreviousPosition(_Base):
 
 
 class PositionCheck(_Base):
-    """How the served position compares with the vessel's previous position report.
-
-    Only ``lookback_hours`` is present when no previous report falls within it.
+    """How the returned position compares with the vessel's previous position report.
+
+    ``lookback_hours`` is always present. ``identity_match`` is present only when a
+    vessel record exists and an identifier can be compared. It is true when the
+    returned position's identifiers match those in the record. The other fields
+    need a previous report within ``lookback_hours``. ``exceeds_typical_speed`` is
+    true when the implied speed exceeds the vessel's usual top speed (99th
+    percentile of its recent speeds).
     """
 
     previous_position: PreviousPosition | None = None
@@ -171,7 +180,9 @@ class PositionCheck(_Base):
 class VesselPositionResponse(_Base):
     """Response for a single vessel position lookup.
 
-    ``vessel`` and ``vessel_eta`` are ``None`` when the API holds no record for them.
+    ``vessel`` is ``None`` when no vessel record exists. ``vessel_eta`` is ``None``
+    when no destination or ETA is available, including when the lookup does not
+    finish in time.
     """
 
     vessel_position: VesselPosition | None = Field(default=None, alias="vesselPosition")

{vessel_api_python-2.1.0.dist-info → vessel_api_python-2.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: vessel-api-python
-Version: 2.1.0
+Version: 2.1.1
 Summary: Python client for the Vessel Tracking API: maritime vessel tracking, port events, emissions, and nautical infrastructure.
 Project-URL: Documentation, https://vesselapi.com/docs
 Project-URL: Repository, https://github.com/vessel-api/vesselapi-python

{vessel_api_python-2.1.0.dist-info → vessel_api_python-2.1.1.dist-info}/RECORD

@@ -1,13 +1,13 @@
 vessel_api_python/__init__.py,sha256=hUlZdyZGgArdYr8XJ30yQibkXXkQPqx3Y9zmVKvi6fc,3200
 vessel_api_python/_client.py,sha256=L7qkzUiATDpPlxWViEKicNpNx7D90gCohas56uCimgA,4919
-vessel_api_python/_constants.py,sha256=rfYu8M4IeUngAqYB6h_N0iwrtVpBA5jDzcT46RjJu7Y,244
+vessel_api_python/_constants.py,sha256=uYgcJuAHCdK1VA7SCknrl41TrRblNCsyXkTOwIAu3fY,244
 vessel_api_python/_errors.py,sha256=DaiyCjYKJZTo6-6sOqAcJBdOeFaIYgWHE48nsHWGeGA,6414
 vessel_api_python/_iterator.py,sha256=SkgsGSdxLrKtw-ad8fSUPaEDDJCamAKK0PrG_P8HX-4,3198
-vessel_api_python/_models.py,sha256=BizjprJtFxyl7064ovks81m31SFdgfxKi6fg3rXjatk,20773
+vessel_api_python/_models.py,sha256=bvvd0yrK4Sa8rZ9ZTWRW2E9VedyInNDQm1NxdOCrbi0,21355
 vessel_api_python/_services.py,sha256=UOGpajcZAYrt03DfkG86nIR8zyCGwokq_qB4ZYit7BY,109699
 vessel_api_python/_transport.py,sha256=pfRaJwkq_GYpA5Ev8wH7tBdlzN2ykgy29Ag1L3F5K4Y,6956
 vessel_api_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vessel_api_python-2.1.0.dist-info/METADATA,sha256=IGgln4OImtva-TRMJIcFqUgPLX8jQdwJYekDdtZ8HiM,10153
-vessel_api_python-2.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-vessel_api_python-2.1.0.dist-info/licenses/LICENSE,sha256=zoj_abq99mj8cz-Bz71XCnwB-Qv3kU1VzVXeKEntuQU,1067
-vessel_api_python-2.1.0.dist-info/RECORD,,
+vessel_api_python-2.1.1.dist-info/METADATA,sha256=-TbomFF0ihDCKicRL34-iCsPG9EUyuKuW6YX0G4cqp0,10153
+vessel_api_python-2.1.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+vessel_api_python-2.1.1.dist-info/licenses/LICENSE,sha256=zoj_abq99mj8cz-Bz71XCnwB-Qv3kU1VzVXeKEntuQU,1067
+vessel_api_python-2.1.1.dist-info/RECORD,,