apiverve-vindecoder 1.1.5__tar.gz → 1.2.2__tar.gz

{apiverve_vindecoder-1.1.5 → apiverve_vindecoder-1.2.2}/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 APIVerve, and Evlar LLC
-
-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:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-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
+The MIT License (MIT)
+
+Copyright (c) 2026 APIVerve and EvlarSoft LLC
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

apiverve_vindecoder-1.2.2/PKG-INFO

@@ -0,0 +1,496 @@
+Metadata-Version: 2.4
+Name: apiverve-vindecoder
+Version: 1.2.2
+Summary: VIN Decoder turns a 17-character Vehicle Identification Number into the vehicle it identifies. Returns make, model, year, trim, body class and manufacturer, plus engine specifications, plant of manufacture, and the safety equipment fitted to that specific build. Optionally adds every safety recall issued for that vehicle and its NHTSA 5-star crash-test rating.
+Author-email: APIVerve <hello@apiverve.com>
+License: MIT
+Project-URL: Homepage, https://apiverve.com/marketplace/vindecoder?utm_source=pypi&utm_medium=referral&utm_content=homepage
+Project-URL: Documentation, https://docs.apiverve.com/ref/vindecoder?utm_source=pypi&utm_medium=referral&utm_content=docs
+Project-URL: Repository, https://github.com/apiverve/vindecoder-api
+Project-URL: Twitter, https://twitter.com/apivervehq
+Keywords: vin decoder api,vin api,nhtsa vin decoder api,vin lookup api,vin decoder
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Natural Language :: English
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Dynamic: license-file
+
+VIN Decoder API
+============
+
+VIN Decoder turns a 17-character Vehicle Identification Number into the vehicle it identifies. Returns make, model, year, trim, body class and manufacturer, plus engine specifications, plant of manufacture, and the safety equipment fitted to that specific build. Optionally adds every safety recall issued for that vehicle and its NHTSA 5-star crash-test rating.
+
+
+[![PyPI version](https://img.shields.io/pypi/v/apiverve-vindecoder.svg)](https://pypi.org/project/apiverve-vindecoder/)
+
+This is a Python wrapper for the [VIN Decoder API](https://apiverve.com/marketplace/vindecoder?utm_source=pypi&utm_medium=referral&utm_content=readme)
+
+---
+
+## Installation
+
+Using `pip`:
+
+```bash
+pip install apiverve-vindecoder
+```
+
+Using `pip3`:
+
+```bash
+pip3 install apiverve-vindecoder
+```
+
+---
+
+## Configuration
+
+Before using the VIN Decoder API client, you have to setup your account and obtain your API Key.
+You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=pypi&utm_medium=referral&utm_content=readme)
+
+---
+
+## Quick Start
+
+Here's a simple example to get you started quickly:
+
+```python
+from apiverve_vindecoder.apiClient import VindecoderAPIClient
+
+# Initialize the client with your APIVerve API key
+api = VindecoderAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "vin": "1HGCM82633A004352",
+    "recalls": true,
+    "safetyRating": true
+}
+
+try:
+    # Make the API call
+    result = api.execute(query)
+
+    # Print the result
+    print(result)
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+---
+
+## Usage
+
+The VIN Decoder API documentation is found here: [https://docs.apiverve.com/ref/vindecoder](https://docs.apiverve.com/ref/vindecoder?utm_source=pypi&utm_medium=referral&utm_content=readme).
+You can find parameters, example responses, and status codes documented here.
+
+### Setup
+
+```python
+# Import the client module
+from apiverve_vindecoder.apiClient import VindecoderAPIClient
+
+# Initialize the client with your APIVerve API key
+api = VindecoderAPIClient("[YOUR_API_KEY]")
+```
+
+---
+
+## Perform Request
+
+Using the API client, you can perform requests to the API.
+
+###### Define Query
+
+```python
+query = {
+    "vin": "1HGCM82633A004352",
+    "recalls": true,
+    "safetyRating": true
+}
+```
+
+###### Simple Request
+
+```python
+# Make a request to the API
+result = api.execute(query)
+
+# Print the result
+print(result)
+```
+
+###### Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "vin": "1HGCM82633A004352",
+    "valid": true,
+    "decoded": true,
+    "vehicleDescriptor": "1HGCM826*3A",
+    "make": "HONDA",
+    "model": "Accord",
+    "year": 2003,
+    "trim": "EX-V6",
+    "trim2": null,
+    "series": null,
+    "series2": null,
+    "manufacturer": "AMERICAN HONDA MOTOR CO., INC.",
+    "vehicleType": "PASSENGER CAR",
+    "bodyClass": "Coupe",
+    "plant": {
+      "state": "OHIO",
+      "country": "UNITED STATES (USA)",
+      "city": "MARYSVILLE"
+    },
+    "engine": {
+      "displacementL": "2.998832712",
+      "displacementCc": "2998.832712",
+      "engineNumberOfCylinders": "6",
+      "engineModel": "J30A4",
+      "engineConfiguration": "V-Shaped",
+      "engineBrakeHpFrom": "240",
+      "displacementCi": "183",
+      "fuelTypePrimary": "Gasoline",
+      "valveTrainDesign": "Single Overhead Cam (SOHC)"
+    },
+    "features": {
+      "passiveSafetySystem": {
+        "otherRestraintSystemInfo": "Seat Belt (Rr center position)",
+        "seatBeltType": "Manual",
+        "sideAirBagLocations": "1st Row (Driver and Passenger)",
+        "curtainAirBagLocations": "1st and 2nd Rows",
+        "frontAirBagLocations": "1st Row (Driver and Passenger)"
+      },
+      "exterior": {
+        "grossVehicleWeightRatingFrom": "Class 1C: 4,001 - 5,000 lb (1,814 - 2,268 kg)",
+        "grossVehicleWeightRatingTo": "Class 1: 6,000 lb or less (2,722 kg or less)",
+        "doors": "2"
+      },
+      "mechanical": {
+        "transmissionStyle": "Automatic",
+        "transmissionSpeeds": "5"
+      }
+    },
+    "validation": {
+      "errorText": "0 - VIN decoded clean. Check Digit (9th position) is correct",
+      "errorCode": "0",
+      "errorCodes": [
+        "0"
+      ]
+    },
+    "recalls": {
+      "count": 13,
+      "doNotDrive": false,
+      "parkOutside": false,
+      "bySeverity": {
+        "critical": 0,
+        "high": 10,
+        "medium": 3,
+        "low": 0
+      },
+      "latestReportedOn": "2019-06-27",
+      "items": [
+        {
+          "id": "19V499000",
+          "manufacturerRecallId": "Q5A, Y58",
+          "manufacturer": "Honda (American Honda Motor Co.)",
+          "reportedOn": "2019-06-27",
+          "ownersNotifiedOn": "2019-08-12",
+          "initiatedBy": "nhtsa",
+          "components": [
+            {
+              "system": "Air Bags",
+              "detail": "Frontal › Driver Side › Inflator Module"
+            }
+          ],
+          "summary": "Honda (American Honda Motor Co.) is recalling certain 2003 Acura 3.2CL, 2002-2003 3.2TL, 2003-2006 MDX, 2001-2007 Honda Accord, 2001-2005 Civic, 2003-2005 Civic Hybrid, 2001-2005 Civic GX NGV, 2002-2006 CR-V, 2003-2011 Element, 2002-2004 Odyssey, 2003-2008 Pilot and 2006 Ridgeline vehicles. These vehicles are equipped with driver frontal air bag inflators assembled as a recall remedy part or replacement service part, that may explode due to propellant degradation occurring after long-term exposure to high absolute humidity, temperature and temperature cycling.",
+          "consequence": "An inflator explosion may result in sharp metal fragments striking the driver or other occupants resulting in serious injury or death.",
+          "hazards": [
+            "injury",
+            "death"
+          ],
+          "doNotDrive": false,
+          "parkOutside": false,
+          "remedy": {
+            "description": "Honda will notify owners, and dealers will replace the driver frontal air bag inflator, free of charge. The recall began August 12, 2019. Owners may contact Honda customer service at 1-888-234-2138. Honda's numbers for this recall are Q5A and Y58.",
+            "status": "available",
+            "overTheAir": false,
+            "freeOfCharge": true
+          },
+          "unitsAffected": 3947,
+          "manufactured": {
+            "from": "2000-07-10",
+            "to": "2011-02-22"
+          },
+          "scope": {
+            "makes": 2,
+            "models": 12,
+            "modelYears": {
+              "from": 2001,
+              "to": 2011
+            }
+          },
+          "url": "https://www.nhtsa.gov/recalls?nhtsaId=19V499000",
+          "severity": "high",
+          "match": "exact",
+          "listedAs": "ACCORD"
+        },
+        {
+          "id": "19V501000",
+          "manufacturerRecallId": "E5D, X5C",
+          "manufacturer": "Honda (American Honda Motor Co.)",
+          "reportedOn": "2019-06-27",
+          "ownersNotifiedOn": "2019-08-12",
+          "initiatedBy": "nhtsa",
+          "components": [
+            {
+              "system": "Air Bags",
+              "detail": "Frontal › Passenger Side › Inflator Module"
+            }
+          ],
+          "summary": "Honda (American Honda Motor Co.) is recalling certain 2003-2006 Acura MDX, 2005-2012 RL, 2003-2007 Honda Accord, 2001-2005 Civic, 2003-2005 Civic Hybrid, 2001-2005 Civic GX NGV, 2002-2006 CR-V, 2003-2011 Element, 2007-2008 Fit, 2002-2004 Odyssey, 2003-2008 Pilot, and 2006-2014 Ridgeline vehicles. The vehicles are equipped with passenger frontal air bag inflators assembled as a recall remedy part or replacement service part, that may explode due to propellant degradation occurring after long-term exposure to high absolute humidity, temperature and temperature cycling.",
+          "consequence": "An inflator explosion may result in sharp metal fragments striking the driver or other occupants resulting in serious injury or death.",
+          "hazards": [
+            "injury",
+            "death"
+          ],
+          "doNotDrive": false,
+          "parkOutside": false,
+          "remedy": {
+            "description": "Honda will notify owners, and dealers will replace the passenger frontal airbag inflator, free of charge. The recall began August 12, 2019. Owners may contact Honda customer service at 1-888-234-2138. Honda's numbers for this recall are E5D and X5C.",
+            "status": "available",
+            "overTheAir": false,
+            "freeOfCharge": true
+          },
+          "unitsAffected": 1657752,
+          "manufactured": {
+            "from": "2000-04-25",
+            "to": "2014-06-02"
+          },
+          "scope": {
+            "makes": 2,
+            "models": 12,
+            "modelYears": {
+              "from": 2001,
+              "to": 2014
+            }
+          },
+          "url": "https://www.nhtsa.gov/recalls?nhtsaId=19V501000",
+          "severity": "high",
+          "match": "exact",
+          "listedAs": "ACCORD"
+        }
+      ]
+    },
+    "safetyRating": {
+      "testedVehicle": "2003 Honda Accord 2-DR. w/SAB",
+      "match": "exact",
+      "variantsTested": 4,
+      "overall": null,
+      "frontal": {
+        "overall": null,
+        "driver": 5,
+        "passenger": 5
+      },
+      "side": {
+        "overall": null,
+        "driver": null,
+        "passenger": null,
+        "barrier": null,
+        "pole": null,
+        "frontSeat": null,
+        "rearSeat": null
+      },
+      "rollover": {
+        "rating": 4,
+        "riskPercent": null,
+        "tipped": null
+      },
+      "driverAssist": {
+        "electronicStabilityControl": "notAvailable",
+        "forwardCollisionWarning": "notAvailable",
+        "laneDepartureWarning": "notAvailable"
+      }
+    }
+  }
+}
+```
+
+---
+
+## Error Handling
+
+The API client provides comprehensive error handling through the `VindecoderAPIClientError` exception. Here are some examples:
+
+### Basic Error Handling
+
+```python
+from apiverve_vindecoder.apiClient import VindecoderAPIClient, VindecoderAPIClientError
+
+api = VindecoderAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "vin": "1HGCM82633A004352",
+    "recalls": true,
+    "safetyRating": true
+}
+
+try:
+    result = api.execute(query)
+    print("Success!")
+    print(result)
+except VindecoderAPIClientError as e:
+    print(f"API Error: {e.message}")
+    if e.status_code:
+        print(f"Status Code: {e.status_code}")
+    if e.response:
+        print(f"Response: {e.response}")
+```
+
+### Handling Specific Error Types
+
+```python
+from apiverve_vindecoder.apiClient import VindecoderAPIClient, VindecoderAPIClientError
+
+api = VindecoderAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "vin": "1HGCM82633A004352",
+    "recalls": true,
+    "safetyRating": true
+}
+
+try:
+    result = api.execute(query)
+
+    # Check for successful response
+    if result.get('status') == 'success':
+        print("Request successful!")
+        print(result.get('data'))
+    else:
+        print(f"API returned an error: {result.get('error')}")
+
+except VindecoderAPIClientError as e:
+    # Handle API client errors
+    if e.status_code == 401:
+        print("Unauthorized: Invalid API key")
+    elif e.status_code == 429:
+        print("Rate limit exceeded")
+    elif e.status_code >= 500:
+        print("Server error - please try again later")
+    else:
+        print(f"API error: {e.message}")
+except Exception as e:
+    # Handle unexpected errors
+    print(f"Unexpected error: {str(e)}")
+```
+
+### Using Context Manager (Recommended)
+
+The client supports the context manager protocol for automatic resource cleanup:
+
+```python
+from apiverve_vindecoder.apiClient import VindecoderAPIClient, VindecoderAPIClientError
+
+query = {
+    "vin": "1HGCM82633A004352",
+    "recalls": true,
+    "safetyRating": true
+}
+
+# Using context manager ensures proper cleanup
+with VindecoderAPIClient("[YOUR_API_KEY]") as api:
+    try:
+        result = api.execute(query)
+        print(result)
+    except VindecoderAPIClientError as e:
+        print(f"Error: {e.message}")
+# Session is automatically closed here
+```
+
+---
+
+## Advanced Features
+
+### Debug Mode
+
+Enable debug logging to see detailed request and response information:
+
+```python
+from apiverve_vindecoder.apiClient import VindecoderAPIClient
+
+# Enable debug mode
+api = VindecoderAPIClient("[YOUR_API_KEY]", debug=True)
+
+query = {
+    "vin": "1HGCM82633A004352",
+    "recalls": true,
+    "safetyRating": true
+}
+
+# Debug information will be printed to console
+result = api.execute(query)
+```
+
+### Manual Session Management
+
+If you need to manually manage the session lifecycle:
+
+```python
+from apiverve_vindecoder.apiClient import VindecoderAPIClient
+
+api = VindecoderAPIClient("[YOUR_API_KEY]")
+
+query = {
+    "vin": "1HGCM82633A004352",
+    "recalls": true,
+    "safetyRating": true
+}
+
+try:
+    result = api.execute(query)
+    print(result)
+finally:
+    # Manually close the session when done
+    api.close()
+```
+
+---
+
+## Customer Support
+
+Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=pypi&utm_medium=referral&utm_content=readme).
+
+---
+
+## Updates
+Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
+
+---
+
+## Legal
+
+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.
+
+---
+
+## License
+Licensed under the MIT License (MIT)
+
+Copyright (&copy;) 2026 APIVerve, and EvlarSoft LLC
+
+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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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.