Compare commits
5 Commits
Author | SHA1 | Date | |
---|---|---|---|
fc15c6fbbe | |||
3ba8c86b53 | |||
1b15946a55 | |||
f2b5b184ea | |||
70b723b781 |
31
README.md
31
README.md
@ -11,13 +11,9 @@
|
||||
**🤖 Nvidia Stock Bot** - A bot that alerts you in real-time about **Nvidia RTX FE** GPU stock availability through Discord notifications.
|
||||
|
||||
> [!NOTE]
|
||||
>_Github repo is a mirror of https://git.djeex.fr/Djeex/nvidia-stock-bot. You'll find full package, history and release note there. LLM used for bugs check and languages files generation._
|
||||
|
||||
## 🖼️ Screenshots
|
||||
|
||||
<div align="center" >
|
||||
<img src="https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/nvidia-stock-bot-discord-screenshot.png" alt="Nvidia Stock Bot - screenshots">
|
||||
</div>
|
||||
>_The code was partially written and structured using a generative AI._
|
||||
>
|
||||
>_Github repo is a mirror of https://git.djeex.fr/Djeex/nvidia-stock-bot. You'll find full package, history and release note there._
|
||||
|
||||
## 📌 Table of Contents
|
||||
|
||||
@ -25,8 +21,8 @@
|
||||
- [🐳 Docker Installation without cloning the repo (quick)](#-docker-installation-without-the-repo-quick)
|
||||
- [🐙 Docker Installation with the repo (developer)](#-docker-installation-with-the-repo)
|
||||
- [🐍 Python Installation (developer)](#-python-installation)
|
||||
- [🖼️ Screenshots](#-screenshots)
|
||||
- [🐞 Common issues](#-common-issues)
|
||||
- [❓ How it works](#-how-it-works)
|
||||
- [🧑💻 Contributors](#-contributors)
|
||||
|
||||
## ✨ Features
|
||||
@ -72,7 +68,8 @@ services:
|
||||
|---------------------|-------------------------------------------------|------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
|
||||
| `PRODUCT_NAMES` | The exact GPU names you're searching for | `RTX 5080, RTX 5090` | |
|
||||
| `DISCORD_WEBHOOK_URL` | Your Discord webhook URL | A valid URL | |
|
||||
| `COUNTRY` | Your country (only one). API localization, Discord notification currency and language will be set accordingly | `GB`, `US`, `CA`, `BE`, `NL`, `DK`, `DE`, `ES`, `FR`, `IT`, `NO`, `AT`, `PL`, `FI`, `SE`, `KR`, `JP` | `US` |
|
||||
| `COUNTRY` | Your country (only one). API localization, Discord notification currency and language will be set accordingly | `GB`, `US`, `CA`, `BE`, `NL`, `DK`, `DE`, `ES`, `FR`, `IT`, `NO`, `AT`, `PL`, `FI`, `SE`, `KR`, `JP`
|
||||
| `US` |
|
||||
| `DISCORD_SERVER_NAME` | The name of your server, displayed in notification's footer | A text | Shared for free |
|
||||
| `DISCORD_ROLES` | List of Discord roles ID in the same order than `PRODUCT_NAMES` values, found in your discord server settings (with user profile developer mode enabled) | `<@&12345><@&6789>` | @everyone |
|
||||
| `REFRESH_TIME` | Script refresh interval in seconds | `60`, `30`, etc. | `30` |
|
||||
@ -154,7 +151,7 @@ git clone https://git.djeex.fr/Djeex/nvidia-stock-bot.git
|
||||
|
||||
```sh
|
||||
export DISCORD_WEBHOOK_URL="https://your_discord_url"
|
||||
export COUNTRY=US
|
||||
export COUNTRY=€
|
||||
export PRODUCT_NAMES=RTX 5080, RTX 5090
|
||||
export DISCORD_ROLES=<@&12345>, <@&6789>
|
||||
export REFRESH_TIME="60"
|
||||
@ -168,19 +165,19 @@ export PYTHONUNBUFFERED=1
|
||||
python nvidia-stock-bot.py
|
||||
```
|
||||
|
||||
## 🖼️ Screenshots
|
||||
|
||||
<div align="center" >
|
||||
<img src="https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/nvidia-stock-bot-discord.png" alt="Nvidia Stock Bot - screenshots">
|
||||
</div>
|
||||
|
||||
## 🐞 Common issues
|
||||
|
||||
Error when trying to reach product API url :
|
||||
- Custom `API_SKU_URL` may be wrong
|
||||
- `API_SKU_URL` may be wrong
|
||||
- Your IP may be blacklisted by nvidia. Try to use a VPN.
|
||||
- nvidia API may be down
|
||||
|
||||
## ❓ How it works
|
||||
|
||||
<div align="center" >
|
||||
<img src="https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/nvidia-stock-bot-scheme.svg" alt="Nvidia Stock Bot - screenshots">
|
||||
</div>
|
||||
|
||||
## 🧑💻 Contributors
|
||||
|
||||
Thanks for their contributions:
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 257 KiB |
BIN
assets/img/nvidia-stock-bot-discord.png
Normal file
BIN
assets/img/nvidia-stock-bot-discord.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 95 KiB |
File diff suppressed because one or more lines are too long
Before Width: | Height: | Size: 739 KiB |
@ -1,3 +1,5 @@
|
||||
PRODUCT_NAMES= # Exact GPU name (e.g. "RTX 5080, RTX 5090")
|
||||
DISCORD_WEBHOOK_URL= # Your Discord webhook URL
|
||||
COUNTRY= # Set your country (e.g. 'US')
|
||||
API_URL_SKU= # API listing the product for your country
|
||||
API_URL_STOCK= # API providing stock data for your country
|
||||
PRODUCT_URL= # GPU purchase URL for your country
|
@ -7,9 +7,10 @@ services:
|
||||
- .env
|
||||
environment:
|
||||
# Minimal environment variables
|
||||
environment:
|
||||
# Minimal environment variables
|
||||
- PRODUCT_NAMES=${PRODUCT_NAMES}
|
||||
- DISCORD_WEBHOOK_URL=${DISCORD_WEBHOOK_URL}
|
||||
- COUNTRY=${COUNTRY}
|
||||
- PYTHONUNBUFFERED=1
|
||||
- PRODUCT_NAMES= # Exact GPU name (e.g. "RTX 5080, RTX 5090")
|
||||
- DISCORD_WEBHOOK_URL= # Your Discord webhook URL
|
||||
- DISCORD_NOTIFICATION_CURRENCY= # Set your country currency
|
||||
- API_URL_SKU= # API listing the product for your country
|
||||
- API_URL_STOCK= # API providing stock data for your country
|
||||
- PRODUCT_URL= # GPU purchase URL for your country
|
||||
- PYTHONUNBUFFERED=1 # Enables real-time log output
|
Reference in New Issue
Block a user