apiverve-aircrafttypes 1.2.6__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.
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2026 APIVerve and EvlarSoft LLC
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,398 @@
1
+ Metadata-Version: 2.4
2
+ Name: apiverve-aircrafttypes
3
+ Version: 1.2.6
4
+ Summary: Aircraft Types returns the physical and operational characteristics of an aircraft type from its ICAO designator, such as B738 or A320, or by searching manufacturer and model. Each type comes with wingspan, length, tail height, maximum takeoff and landing weight, approach speed and category, airplane design group, ICAO wake turbulence category and FAA weight class, with metric conversions. Paid plans add airport planning geometry, RECAT wake categories and US registration and traffic counts.
5
+ Author-email: APIVerve <hello@apiverve.com>
6
+ License: MIT
7
+ Project-URL: Homepage, https://apiverve.com/marketplace/aircrafttypes?utm_source=pypi&utm_medium=referral&utm_content=homepage
8
+ Project-URL: Documentation, https://docs.apiverve.com/ref/aircrafttypes?utm_source=pypi&utm_medium=referral&utm_content=docs
9
+ Project-URL: Repository, https://github.com/apiverve/aircrafttypes-api
10
+ Project-URL: Twitter, https://twitter.com/apivervehq
11
+ Keywords: aircraft types api,aircraft specifications api,aircraft dimensions,icao aircraft type designator,aircraft wingspan
12
+ Classifier: Development Status :: 5 - Production/Stable
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Topic :: Internet :: WWW/HTTP
17
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
18
+ Classifier: Natural Language :: English
19
+ Requires-Python: >=3.9
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Requires-Dist: requests>=2.25.0
23
+ Dynamic: license-file
24
+
25
+ Aircraft Types API
26
+ ============
27
+
28
+ Aircraft Types returns the physical and operational characteristics of an aircraft type from its ICAO designator, such as B738 or A320, or by searching manufacturer and model. Each type comes with wingspan, length, tail height, maximum takeoff and landing weight, approach speed and category, airplane design group, ICAO wake turbulence category and FAA weight class, with metric conversions. Paid plans add airport planning geometry, RECAT wake categories and US registration and traffic counts.
29
+
30
+
31
+ [![PyPI version](https://img.shields.io/pypi/v/apiverve-aircrafttypes.svg)](https://pypi.org/project/apiverve-aircrafttypes/)
32
+
33
+ This is a Python wrapper for the [Aircraft Types API](https://apiverve.com/marketplace/aircrafttypes?utm_source=pypi&utm_medium=referral&utm_content=readme)
34
+
35
+ ---
36
+
37
+ ## Installation
38
+
39
+ Using `pip`:
40
+
41
+ ```bash
42
+ pip install apiverve-aircrafttypes
43
+ ```
44
+
45
+ Using `pip3`:
46
+
47
+ ```bash
48
+ pip3 install apiverve-aircrafttypes
49
+ ```
50
+
51
+ ---
52
+
53
+ ## Configuration
54
+
55
+ Before using the Aircraft Types API client, you have to setup your account and obtain your API Key.
56
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=pypi&utm_medium=referral&utm_content=readme)
57
+
58
+ ---
59
+
60
+ ## Quick Start
61
+
62
+ Here's a simple example to get you started quickly:
63
+
64
+ ```python
65
+ from apiverve_aircrafttypes.apiClient import AircrafttypesAPIClient
66
+
67
+ # Initialize the client with your APIVerve API key
68
+ api = AircrafttypesAPIClient("[YOUR_API_KEY]")
69
+
70
+ query = {
71
+ "icao": "B738",
72
+ "manufacturer": "Airbus",
73
+ "model": "737",
74
+ "engineType": "jet",
75
+ "wakeCategory": "heavy",
76
+ "engines": 2,
77
+ "limit": 10
78
+ }
79
+
80
+ try:
81
+ # Make the API call
82
+ result = api.execute(query)
83
+
84
+ # Print the result
85
+ print(result)
86
+ except Exception as e:
87
+ print(f"Error: {e}")
88
+ ```
89
+
90
+ ---
91
+
92
+ ## Usage
93
+
94
+ The Aircraft Types API documentation is found here: [https://docs.apiverve.com/ref/aircrafttypes](https://docs.apiverve.com/ref/aircrafttypes?utm_source=pypi&utm_medium=referral&utm_content=readme).
95
+ You can find parameters, example responses, and status codes documented here.
96
+
97
+ ### Setup
98
+
99
+ ```python
100
+ # Import the client module
101
+ from apiverve_aircrafttypes.apiClient import AircrafttypesAPIClient
102
+
103
+ # Initialize the client with your APIVerve API key
104
+ api = AircrafttypesAPIClient("[YOUR_API_KEY]")
105
+ ```
106
+
107
+ ---
108
+
109
+ ## Perform Request
110
+
111
+ Using the API client, you can perform requests to the API.
112
+
113
+ ###### Define Query
114
+
115
+ ```python
116
+ query = {
117
+ "icao": "B738",
118
+ "manufacturer": "Airbus",
119
+ "model": "737",
120
+ "engineType": "jet",
121
+ "wakeCategory": "heavy",
122
+ "engines": 2,
123
+ "limit": 10
124
+ }
125
+ ```
126
+
127
+ ###### Simple Request
128
+
129
+ ```python
130
+ # Make a request to the API
131
+ result = api.execute(query)
132
+
133
+ # Print the result
134
+ print(result)
135
+ ```
136
+
137
+ ###### Example Response
138
+
139
+ ```json
140
+ {
141
+ "status": "ok",
142
+ "error": null,
143
+ "data": {
144
+ "count": 1,
145
+ "returned": 1,
146
+ "types": [
147
+ {
148
+ "icaoCode": "B738",
149
+ "faaDesignator": "B738",
150
+ "manufacturer": "BOEING",
151
+ "model": "Boeing 737-800",
152
+ "variant": "Boeing B737-800",
153
+ "aircraftClass": "Fixed-wing",
154
+ "engineType": "Jet",
155
+ "engineCount": 2,
156
+ "wingspanFt": 117.4,
157
+ "wingspanWithoutWingletsFt": 112.6,
158
+ "hasWinglets": true,
159
+ "lengthFt": 129.5,
160
+ "tailHeightFt": 41.4,
161
+ "maxTakeoffWeightLb": 174200,
162
+ "maxLandingWeightLb": 146275,
163
+ "approachSpeedKnots": 144,
164
+ "approachSpeedRangeKnots": {
165
+ "min": 140,
166
+ "max": 144
167
+ },
168
+ "approachCategory": "D",
169
+ "designGroup": "III",
170
+ "icaoWakeCategory": "Medium",
171
+ "faaWeightClass": "Large",
172
+ "metric": {
173
+ "wingspanM": 35.78,
174
+ "lengthM": 39.47,
175
+ "tailHeightM": 12.62,
176
+ "maxTakeoffWeightKg": 79016,
177
+ "maxLandingWeightKg": 66349
178
+ },
179
+ "airport": {
180
+ "taxiwayDesignGroup": "3",
181
+ "wheelbaseFt": 51.2,
182
+ "cockpitToMainGearFt": 56.4,
183
+ "mainGearWidthFt": 23,
184
+ "mainGearConfig": "D",
185
+ "parkingAreaFt2": 16487,
186
+ "parkingAreaM2": 1532,
187
+ "rotorDiameterFt": null
188
+ },
189
+ "wake": {
190
+ "consolidatedCategory": "F",
191
+ "recat15Category": "D",
192
+ "recat2CategoryA": "D",
193
+ "recat2CategoryB": "C",
194
+ "sameRunwaySeparation": "III",
195
+ "lahsoGroup": "8"
196
+ },
197
+ "usage": {
198
+ "usRegistered": true,
199
+ "usRegistrations": 971,
200
+ "annualFlightPlanOperations": 2484764,
201
+ "operationsYear": 2024
202
+ },
203
+ "remarks": "Depending on flaps configuration and MALW, AAC could be C. AAC validated by Flight Standardization Board (FSB) report.",
204
+ "lastUpdated": null
205
+ }
206
+ ]
207
+ }
208
+ }
209
+ ```
210
+
211
+ ---
212
+
213
+ ## Error Handling
214
+
215
+ The API client provides comprehensive error handling through the `AircrafttypesAPIClientError` exception. Here are some examples:
216
+
217
+ ### Basic Error Handling
218
+
219
+ ```python
220
+ from apiverve_aircrafttypes.apiClient import AircrafttypesAPIClient, AircrafttypesAPIClientError
221
+
222
+ api = AircrafttypesAPIClient("[YOUR_API_KEY]")
223
+
224
+ query = {
225
+ "icao": "B738",
226
+ "manufacturer": "Airbus",
227
+ "model": "737",
228
+ "engineType": "jet",
229
+ "wakeCategory": "heavy",
230
+ "engines": 2,
231
+ "limit": 10
232
+ }
233
+
234
+ try:
235
+ result = api.execute(query)
236
+ print("Success!")
237
+ print(result)
238
+ except AircrafttypesAPIClientError as e:
239
+ print(f"API Error: {e.message}")
240
+ if e.status_code:
241
+ print(f"Status Code: {e.status_code}")
242
+ if e.response:
243
+ print(f"Response: {e.response}")
244
+ ```
245
+
246
+ ### Handling Specific Error Types
247
+
248
+ ```python
249
+ from apiverve_aircrafttypes.apiClient import AircrafttypesAPIClient, AircrafttypesAPIClientError
250
+
251
+ api = AircrafttypesAPIClient("[YOUR_API_KEY]")
252
+
253
+ query = {
254
+ "icao": "B738",
255
+ "manufacturer": "Airbus",
256
+ "model": "737",
257
+ "engineType": "jet",
258
+ "wakeCategory": "heavy",
259
+ "engines": 2,
260
+ "limit": 10
261
+ }
262
+
263
+ try:
264
+ result = api.execute(query)
265
+
266
+ # Check for successful response
267
+ if result.get('status') == 'success':
268
+ print("Request successful!")
269
+ print(result.get('data'))
270
+ else:
271
+ print(f"API returned an error: {result.get('error')}")
272
+
273
+ except AircrafttypesAPIClientError as e:
274
+ # Handle API client errors
275
+ if e.status_code == 401:
276
+ print("Unauthorized: Invalid API key")
277
+ elif e.status_code == 429:
278
+ print("Rate limit exceeded")
279
+ elif e.status_code >= 500:
280
+ print("Server error - please try again later")
281
+ else:
282
+ print(f"API error: {e.message}")
283
+ except Exception as e:
284
+ # Handle unexpected errors
285
+ print(f"Unexpected error: {str(e)}")
286
+ ```
287
+
288
+ ### Using Context Manager (Recommended)
289
+
290
+ The client supports the context manager protocol for automatic resource cleanup:
291
+
292
+ ```python
293
+ from apiverve_aircrafttypes.apiClient import AircrafttypesAPIClient, AircrafttypesAPIClientError
294
+
295
+ query = {
296
+ "icao": "B738",
297
+ "manufacturer": "Airbus",
298
+ "model": "737",
299
+ "engineType": "jet",
300
+ "wakeCategory": "heavy",
301
+ "engines": 2,
302
+ "limit": 10
303
+ }
304
+
305
+ # Using context manager ensures proper cleanup
306
+ with AircrafttypesAPIClient("[YOUR_API_KEY]") as api:
307
+ try:
308
+ result = api.execute(query)
309
+ print(result)
310
+ except AircrafttypesAPIClientError as e:
311
+ print(f"Error: {e.message}")
312
+ # Session is automatically closed here
313
+ ```
314
+
315
+ ---
316
+
317
+ ## Advanced Features
318
+
319
+ ### Debug Mode
320
+
321
+ Enable debug logging to see detailed request and response information:
322
+
323
+ ```python
324
+ from apiverve_aircrafttypes.apiClient import AircrafttypesAPIClient
325
+
326
+ # Enable debug mode
327
+ api = AircrafttypesAPIClient("[YOUR_API_KEY]", debug=True)
328
+
329
+ query = {
330
+ "icao": "B738",
331
+ "manufacturer": "Airbus",
332
+ "model": "737",
333
+ "engineType": "jet",
334
+ "wakeCategory": "heavy",
335
+ "engines": 2,
336
+ "limit": 10
337
+ }
338
+
339
+ # Debug information will be printed to console
340
+ result = api.execute(query)
341
+ ```
342
+
343
+ ### Manual Session Management
344
+
345
+ If you need to manually manage the session lifecycle:
346
+
347
+ ```python
348
+ from apiverve_aircrafttypes.apiClient import AircrafttypesAPIClient
349
+
350
+ api = AircrafttypesAPIClient("[YOUR_API_KEY]")
351
+
352
+ query = {
353
+ "icao": "B738",
354
+ "manufacturer": "Airbus",
355
+ "model": "737",
356
+ "engineType": "jet",
357
+ "wakeCategory": "heavy",
358
+ "engines": 2,
359
+ "limit": 10
360
+ }
361
+
362
+ try:
363
+ result = api.execute(query)
364
+ print(result)
365
+ finally:
366
+ # Manually close the session when done
367
+ api.close()
368
+ ```
369
+
370
+ ---
371
+
372
+ ## Customer Support
373
+
374
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=pypi&utm_medium=referral&utm_content=readme).
375
+
376
+ ---
377
+
378
+ ## Updates
379
+ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
380
+
381
+ ---
382
+
383
+ ## Legal
384
+
385
+ All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=pypi&utm_medium=referral&utm_content=readme) and all legal documents and agreements.
386
+
387
+ ---
388
+
389
+ ## License
390
+ Licensed under the MIT License (MIT)
391
+
392
+ Copyright (&copy;) 2026 APIVerve, and EvlarSoft LLC
393
+
394
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
395
+
396
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
397
+
398
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.