jaydeep123423 commited on
Commit
56a25bd
Β·
1 Parent(s): b155041

Add Hugging Face Space metadata

Browse files
Files changed (1) hide show
  1. README.md +9 -74
README.md CHANGED
@@ -1,79 +1,14 @@
1
- # Car Dealership VIN Lookup App
2
-
3
- ![alt text](logo_image.png)
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
- ## πŸš€ Getting Started
27
-
28
- **How to run locally**
29
-
30
- 1. Clone the Repository
31
- git clone https://github.com/averyestopinal/AIPI503PROJECT
32
- cd AIPI503PROJECT
33
-
34
- 2. Create a virtual environment (optional but recommended):
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