Spaces:
No application file
No application file
Commit Β·
56a25bd
1
Parent(s): b155041
Add Hugging Face Space metadata
Browse files
README.md
CHANGED
|
@@ -1,79 +1,14 @@
|
|
| 1 |
-
# Car Dealership VIN Lookup App
|
| 2 |
-
|
| 3 |
-

|
| 4 |
-
|
| 5 |
-
## π Overview
|
| 6 |
-
This is a simple app for a car dealership that allows users to look up vehicle information (year, make, and model) by entering a VIN number.
|
| 7 |
-
|
| 8 |
-
Additionally, the app keeps track of search frequency and lets users view the **Top 3 most looked-up vehicle makes**.
|
| 9 |
-
|
| 10 |
-
All vehicle data is retrieved from the [NHTSA (National Highway Traffic Safety Administration) VIN decoding API](https://vpic.nhtsa.dot.gov/api/), accessed via the helper module [`nhtsa_api_call.py`](./nhtsa_api_call.py).
|
| 11 |
-
|
| 12 |
-
---
|
| 13 |
-
|
| 14 |
-
## βοΈ Features
|
| 15 |
-
- π Lookup vehicle details (year, make, model) by VIN number
|
| 16 |
-
- π View the **Top 3 most searched vehicle makes**
|
| 17 |
-
- π Fetches real-time data from the **NHTSA VIN API**
|
| 18 |
-
- π₯οΈ Simple and interactive command-line interface
|
| 19 |
-
|
| 20 |
-
---
|
| 21 |
-
## π¦ Python Version
|
| 22 |
-
|
| 23 |
-
Tested on: Python 3.10
|
| 24 |
-
|
| 25 |
---
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
python -m venv .venv
|
| 36 |
-
source .venv/bin/activate # macOS/Linux
|
| 37 |
-
.venv\Scripts\activate # Windows
|
| 38 |
-
|
| 39 |
-
3. Install Dependencies
|
| 40 |
-
This app uses only standard Python libraries (no external dependencies).However, make sure you are running Python 3.7+.
|
| 41 |
-
pip install -r requirements.txt
|
| 42 |
-
|
| 43 |
-
4. Run the Streamlit app:
|
| 44 |
-
streamlit run streamlit_app.py
|
| 45 |
-
|
| 46 |
-
**How to Run cli_demo.py**
|
| 47 |
-
This is a simple command-line version of the VIN decoder. Make sure your terminal is in the same directory as cli_demo.py.
|
| 48 |
-
|
| 49 |
-
python cli_demo.py
|
| 50 |
-
|
| 51 |
-
**Link to the Hugging Faces Space**
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
---
|
| 55 |
-
|
| 56 |
-
π§© Project Structure
|
| 57 |
-
.
|
| 58 |
-
βββ streamlit_app.py # Entry point for the Streamlit application
|
| 59 |
-
βββ cli_demo.py # Command-line interface version of the VIN decoder
|
| 60 |
-
βββ nhtsa_api_call.py # Helper module for API requests
|
| 61 |
-
βββ car_image.png # Image file used in the Streamlit application
|
| 62 |
-
βββ logo_image.py # Logo image file used in the Streamlit application
|
| 63 |
-
βββ README.md # Project documentation
|
| 64 |
-
βββ requirements.txt # Python Dependencies
|
| 65 |
-
|
| 66 |
-
---
|
| 67 |
-
π‘ API Reference
|
| 68 |
-
The app uses the NHTSA VIN Decoder API which provides vehicle details when supplied with a VIN number.
|
| 69 |
-
|
| 70 |
-
Example request: https://vpic.nhtsa.dot.gov/api/vehicles/DecodeVinValues/<VIN>?format=json
|
| 71 |
-
|
| 72 |
---
|
| 73 |
-
π Credits
|
| 74 |
-
NHTSA Vehicle API
|
| 75 |
-
Streamlit
|
| 76 |
-
Hugging Face Spaces
|
| 77 |
|
| 78 |
---
|
| 79 |
π¨βπ» Author
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: AIPI503 Project
|
| 3 |
+
emoji: π
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: green
|
| 6 |
+
sdk: streamlit
|
| 7 |
+
sdk_version: 1.36.0
|
| 8 |
+
app_file: streamlit_app.py
|
| 9 |
+
pinned: false
|
| 10 |
+
license: mit
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 11 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
|
| 13 |
---
|
| 14 |
π¨βπ» Author
|