Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ronknight/webjaguar-inventory-checker
🔍 A Python script to validate the inventory status of products on WebJaguar by checking SKUs against their API and logging results to CSV and log files.
https://github.com/ronknight/webjaguar-inventory-checker
csv python webjaguar
Last synced: 11 days ago
JSON representation
🔍 A Python script to validate the inventory status of products on WebJaguar by checking SKUs against their API and logging results to CSV and log files.
- Host: GitHub
- URL: https://github.com/ronknight/webjaguar-inventory-checker
- Owner: ronknight
- License: mit
- Created: 2024-11-20T18:21:33.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-20T19:54:53.000Z (3 months ago)
- Last Synced: 2024-11-29T14:48:39.999Z (2 months ago)
- Topics: csv, python, webjaguar
- Language: Python
- Homepage: https://www.pinoyitsolution.com
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🦈 WebJaguar Inventory Checker
🔍 A Python script to validate the inventory status of products on WebJaguar by checking SKUs against their API and logging results to CSV and log files.
---
Project Overview •
Features •
Setup •
Usage •
Files •
Diagram •
Disclaimer
---
## 📖 Project Overview
The **WebJaguar Inventory Checker** is a Python script designed to streamline inventory management. It reads a list of product SKUs from a CSV file, fetches their statuses from the WebJaguar API, and writes the results to a new CSV file while also logging the responses for debugging purposes.
---
## ✨ Features
- **SKU Status Validation**: Check the `active` status of products on WebJaguar.
- **CSV Input and Output**: Input SKUs via a CSV file and output results with additional columns indicating inventory statuses.
- **Logging**: Logs all API responses to a timestamped log file for transparency and debugging.
- **Environment Variables**: Secures sensitive credentials using a `.env` file.
---
## ⚙️ Setup
1. **Clone the Repository**:
```bash
git clone https://github.com/ronknight/webjaguar-inventory-checker.git
```
2. **Navigate to the Project Directory**:
```bash
cd webjaguar-inventory-checker
```
3. **Install Dependencies**:
Make sure Python 3.6+ is installed. Install required packages using:
```bash
pip install -r requirements.txt
```
4. **Configure Environment Variables**:
Create a `.env` file in the project directory with the following content:
```env
API_URL=https://your-webjaguar-api-url.com
AUTH_CREDENTIALS=your-username:your-password
COOKIE=your-session-cookie
```
---
## 🚀 Usage
1. **Prepare the Input CSV File**:
- Create a file named `product_id.csv` with the following format:
```csv
4SGM_SKU
SKU123
SKU456
SKU789
```
2. **Run the Script**:
- Execute the script to validate product statuses:
```bash
python check_inventory_status.py
```
3. **Review the Outputs**:
- **`product_id_with_status_.csv`**: Contains the original SKUs with an additional `inventory_active` column indicating the product status (`True` or `False`).
- **`response_log_.txt`**: Logs all API responses for auditing or troubleshooting.
---
## 📂 Files
### Key Files
- **`check_inventory_status.py`**: The main Python script for inventory validation.
- **`.env`**: File for securely storing API credentials and other sensitive configuration values.
- **`requirements.txt`**: Lists Python dependencies required to run the script.
### Example/Generated Files
- **`product_id.csv`**: Example input file containing SKUs to validate.
- **`product_id_with_status_.csv`**: Output file with validated statuses.
- **`response_log_.txt`**: Logs API responses for each SKU.
---
## 📊 Diagram
```mermaid
graph TD
A[Start: User Executes Script] -->|Reads Input| B[Input CSV File]
B -->|Extracts SKUs| C[Check SKU Status via API]
C -->|Sends Request| D[WebJaguar API]
D -->|Returns Response| E[Parse API Response]
E -->|Extract Status| F[Write to Output CSV]
F -->|Save Logs| G[Log API Responses]
G --> H[End: Results Saved]
```
## ⚠️ Disclaimer
This script interacts with WebJaguar's API using sensitive credentials (API keys and cookies). Ensure proper security measures, such as excluding `.env` files from version control, and comply with the WebJaguar terms of service. Use at your own risk.
---