feat: enhance README and improve product data handling in cache, llm, reader, and writer modules
This commit is contained in:
66
README.md
66
README.md
@@ -24,6 +24,7 @@ bun run src/index.ts <input.csv|xlsx> [--out results.csv]
|
||||
```
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
bun run src/index.ts leads.xlsx
|
||||
bun run src/index.ts leads.csv --out results.xlsx
|
||||
@@ -34,25 +35,44 @@ bun run src/index.ts leads.csv --out results.xlsx
|
||||
Accepts `.csv` or `.xlsx` files. Column names are matched case-insensitively. Required column:
|
||||
|
||||
| Column | Aliases |
|
||||
|--------|---------|
|
||||
| ASIN | — |
|
||||
| ------ | ------- |
|
||||
| ASIN | — |
|
||||
|
||||
Optional but recommended:
|
||||
|
||||
| Column | Aliases |
|
||||
|--------|---------|
|
||||
| Product Name | Name, Title |
|
||||
| Unit Cost | Cost, Price, Buy Cost |
|
||||
| Brand | — |
|
||||
| Category | — |
|
||||
| Amazon Rank | Amazon Rank, BSR, Sales Rank |
|
||||
| FBA NET | — |
|
||||
| Gross Profit $ | Gross Profit |
|
||||
| Gross Profit % | — |
|
||||
| MOQ | Min Order Qty |
|
||||
| MOQ Cost | — |
|
||||
| Total Qty Avail | Qty Available |
|
||||
| Link | URL, Source |
|
||||
| Column | Aliases |
|
||||
| --------------- | ---------------------------- |
|
||||
| Product Name | Name, Title |
|
||||
| Unit Cost | Cost, Price, Buy Cost |
|
||||
| Brand | — |
|
||||
| Category | — |
|
||||
| Amazon Rank | Amazon Rank, BSR, Sales Rank |
|
||||
| FBA NET | — |
|
||||
| Gross Profit $ | Gross Profit |
|
||||
| Gross Profit % | — |
|
||||
| MOQ | Min Order Qty |
|
||||
| MOQ Cost | — |
|
||||
| Total Qty Avail | Qty Available |
|
||||
| Link | URL, Source |
|
||||
|
||||
Lead-list format aliases (supported):
|
||||
|
||||
| Column | Aliases |
|
||||
| ----------------- | ------------------------------------------ |
|
||||
| Name | Product Name, Title, Product Title |
|
||||
| ASIN Link | ASIN URL, Amazon Link |
|
||||
| Source URL | Source Link, Supplier URL |
|
||||
| 90 Day Average | 90-day Average, Avg Price 90d, 90d Average |
|
||||
| Cost | Unit Cost, Buy Cost, Price |
|
||||
| Selling Price | Sale Price, Sell Price |
|
||||
| Net Profit | Gross Profit |
|
||||
| ROI | Gross Profit %, Return on Investment |
|
||||
| Supplier | Vendor |
|
||||
| Promo/Coupon Code | Promo Code, Coupon Code |
|
||||
| Notes | Note |
|
||||
| Date | Lead Date |
|
||||
|
||||
Numeric parsing accepts plain numbers as well as formatted values like `$12.50`, `1,209.60`, and `27.5%`.
|
||||
|
||||
## Pipeline
|
||||
|
||||
@@ -69,13 +89,13 @@ ASIN, Name, Brand, Category, Unit Cost, Current Price, Avg Price 90d, Sales Rank
|
||||
|
||||
## Environment variables
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `KEEPA_API_KEY` | — | **Required.** Keepa API key |
|
||||
| `REDIS_URL` | `redis://localhost:6379` | Redis connection URL |
|
||||
| `LLM_URL` | `http://localhost:1234/v1` | LM Studio API base URL |
|
||||
| `LLM_MODEL` | `default` | Model name to pass to LM Studio |
|
||||
| `CACHE_TTL` | `86400` | Redis cache TTL in seconds |
|
||||
| Variable | Default | Description |
|
||||
| --------------- | -------------------------- | ------------------------------- |
|
||||
| `KEEPA_API_KEY` | — | **Required.** Keepa API key |
|
||||
| `REDIS_URL` | `redis://localhost:6379` | Redis connection URL |
|
||||
| `LLM_URL` | `http://localhost:1234/v1` | LM Studio API base URL |
|
||||
| `LLM_MODEL` | `default` | Model name to pass to LM Studio |
|
||||
| `CACHE_TTL` | `86400` | Redis cache TTL in seconds |
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
Reference in New Issue
Block a user