vessel-api-python 2.0.0__tar.gz → 2.0.1__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.
@@ -3,6 +3,21 @@
3
3
  All notable changes to this package are documented here.
4
4
  This project follows [Semantic Versioning](https://semver.org/).
5
5
 
6
+ ## [2.0.1] - 2026-10-08
7
+
8
+ Documentation only. No method, parameter or model changed.
9
+
10
+ ### Fixed
11
+
12
+ - The bundled OpenAPI spec named the satellite fallback parameter `sat`; the
13
+ API's parameter is `filter.sat`. Descriptions corrected.
14
+
15
+ ### Changed
16
+
17
+ - README: the satellite fallback note says when it fires (no recent terrestrial
18
+ position stored); the radius example describes the time window it searches
19
+ (default 2 hours, at most 4).
20
+
6
21
  ## [2.0.0] - 2026-08-16
7
22
 
8
23
  Vessel ownership, classification and inspection data, and NAVTEX messages, were
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: vessel-api-python
3
- Version: 2.0.0
3
+ Version: 2.0.1
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,11 +131,12 @@ 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 nothing is stored.
134
+ # filter_sat=True falls back to satellite AIS when no recent terrestrial position is stored.
135
135
  # ⚠️ Satellite lookups draw on a prepaid balance and are charged per call.
136
136
  # Omit it unless you need that fallback.
137
137
 
138
- # Find all vessels within 10 km of Rotterdam.
138
+ # Find vessels with an AIS position within 10 km of Rotterdam in the last 2 hours
139
+ # (the default time window, at most 4 hours).
139
140
  nearby = client.location.vessels_radius(latitude=51.9225, longitude=4.47917, radius=10000)
140
141
  for v in nearby.vessels or []:
141
142
  print(f"{v.vessel_name} at {v.latitude}, {v.longitude}")
@@ -97,11 +97,12 @@ print(f"{vessel.vessel.name} ({vessel.vessel.vessel_type})")
97
97
  pos = client.vessels.position("232003239", filter_id_type="mmsi")
98
98
  print(f"Position: {pos.vessel_position.latitude}, {pos.vessel_position.longitude}")
99
99
 
100
- # filter_sat=True falls back to satellite AIS when nothing is stored.
100
+ # filter_sat=True falls back to satellite AIS when no recent terrestrial position is stored.
101
101
  # ⚠️ Satellite lookups draw on a prepaid balance and are charged per call.
102
102
  # Omit it unless you need that fallback.
103
103
 
104
- # Find all vessels within 10 km of Rotterdam.
104
+ # Find vessels with an AIS position within 10 km of Rotterdam in the last 2 hours
105
+ # (the default time window, at most 4 hours).
105
106
  nearby = client.location.vessels_radius(latitude=51.9225, longitude=4.47917, radius=10000)
106
107
  for v in nearby.vessels or []:
107
108
  print(f"{v.vessel_name} at {v.latitude}, {v.longitude}")
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "vessel-api-python"
7
- version = "2.0.0"
7
+ version = "2.0.1"
8
8
  description = "Python client for the Vessel Tracking API: maritime vessel tracking, port events, emissions, and nautical infrastructure."
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.9"
@@ -1,6 +1,6 @@
1
1
  """Constants for the Vessel API Python SDK."""
2
2
 
3
- VERSION = "2.0.0"
3
+ VERSION = "2.0.1"
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