Fixed logo

Reviewed-on: #8

Dockerfile

@@ -16,7 +16,7 @@ RUN pip install --no-cache-dir -r requirements.txt
 
 # Définir les variables d'environnement par défaut (modifiable lors du lancement du conteneur)
 ENV DISCORD_WEBHOOK_URL="https://example.com/webhook" \
-    REFRESH_TIME="60"
+    REFRESH_TIME="30"
 
 # Exposer un point de commande pour exécuter le script
 CMD ["python", "nvidia-stock-bot.py"]

LICENSE

@@ -1,14 +1,160 @@
-Non-Profit Open Software License 3.0 (NPOSL-3.0)
+Creative Commons Attribution-NonCommercial 4.0 International
 
-Copyright (C) 2025 Djeex - Nvidia Stock Bot
+Copyright (c) Djeex - 2025
 
-The NPOSL-3.0 is a free and open-source license, but it has restrictions.
-You are allowed to:
-- Use, copy, and modify the software for non-commercial purposes.
-- Distribute the software, provided it remains free and non-commercial.
+ Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
 
-You are not allowed to:
-- Use the software for commercial purposes.
-- Modify the software and redistribute it under another license.
+Using Creative Commons Public Licenses
 
-Full text of the license can be found at: https://sourceforge.net/p/npdl/wiki/NPOSL_3_0/
+Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
+
+Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
+
+Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
+
+Creative Commons Attribution-NonCommercial 4.0 International Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NonCommercial 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
+
+Section 1 – Definitions.
+
+     a.	Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
+
+     b.	Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
+
+     c.	Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
+
+     d.	Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
+
+     e.	Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
+
+     f.	Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
+
+     g.	Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
+
+     h.	Licensor means the individual(s) or entity(ies) granting rights under this Public License.
+
+     i.	NonCommercial means not primarily intended for or directed towards commercial advantage or monetary compensation. For purposes of this Public License, the exchange of the Licensed Material for other material subject to Copyright and Similar Rights by digital file-sharing or similar means is NonCommercial provided there is no payment of monetary compensation in connection with the exchange.
+
+     j.	Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
+
+     k.	Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
+
+     l.	You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
+
+Section 2 – Scope.
+
+     a.	License grant.
+
+          1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
+
+               A. reproduce and Share the Licensed Material, in whole or in part, for NonCommercial purposes only; and
+
+               B. produce, reproduce, and Share Adapted Material for NonCommercial purposes only.
+
+          2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
+
+          3. Term. The term of this Public License is specified in Section 6(a).
+
+          4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
+
+          5. Downstream recipients.
+
+               A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
+
+               B. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
+
+          6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
+
+     b.	Other rights.
+
+          1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
+
+          2. Patent and trademark rights are not licensed under this Public License.
+
+          3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties, including when the Licensed Material is used other than for NonCommercial purposes.
+
+Section 3 – License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the following conditions.
+
+     a.	Attribution.
+
+          1. If You Share the Licensed Material (including in modified form), You must:
+
+               A. retain the following if it is supplied by the Licensor with the Licensed Material:
+
+                    i.	identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
+
+                    ii.	a copyright notice;
+
+                    iii. a notice that refers to this Public License;
+
+                    iv.	a notice that refers to the disclaimer of warranties;
+
+                    v.	a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
+
+               B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
+
+               C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
+
+          2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
+
+          3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
+
+          4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License.
+
+Section 4 – Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
+
+     a.	for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database for NonCommercial purposes only;
+
+     b.	if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and
+
+     c.	You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
+For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
+
+Section 5 – Disclaimer of Warranties and Limitation of Liability.
+
+     a.	Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
+
+     b.	To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
+
+     c.	The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
+
+Section 6 – Term and Termination.
+
+     a.	This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
+
+     b.	Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
+
+          1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
+
+          2. upon express reinstatement by the Licensor.
+
+     For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
+
+     c.	For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
+
+     d.	Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
+
+Section 7 – Other Terms and Conditions.
+
+     a.	The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
+
+     b.	Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
+
+Section 8 – Interpretation.
+
+     a.	For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
+
+     b.	To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
+
+     c.	No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
+
+     d.	Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
+
+Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
+
+Creative Commons may be contacted at creativecommons.org.

README.md

@@ -1,125 +1,172 @@
-# Nvidia Stock Bot
-Par KevOut & Djeex
+<h1 align="center">Nvidia Stock Bot</h1>
+<div align="center">
+    <a href="https://discord.gg/gxffg3GA96">
+        <img src="https://img.shields.io/badge/JV%20hardware-join-green?style=flat-square&logo=discord&logoColor=%23fff" alt="JV Hardware">
+    <a href="https://creativecommons.org/licenses/by-nc/4.0/" target="_blank">
+        <img src="https://img.shields.io/badge/License-CC%20BY--NC%204.0-8E44AD?style=flat-square" alt="License: CC BY-NC 4.0">
+    </a>
+</div>
+<div align="center" >
+    <img src="https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/nvidia-stock-bot-logo.png" alt="Nvidia Stock Bot" width="300">
+</div>
 
-*Ce projet est protégé par la license Non-Profit Open Software License 3.0 (NPOSL-3.0)*
+**🤖 Nvidia Stock Bot** - A bot that alerts you in real-time about **Nvidia RTX FE** GPU stock availability through Discord notifications.
 
+*The code was partially written and structured using a generative AI.*
 
-[![](https://img.shields.io/badge/JV%20hardware-rejoindre-green?style=flat-square&logo=discord&logoColor=%23fff&label=JV%20hardware&link=https%3A%2F%2Fdiscord.gg%2Fgxffg3GA96)](https://discord.gg/gxffg3GA96) ![Licence: NPOSL-3.0](https://img.shields.io/badge/license-NPOSL--3.0-blue?style=flat-square&)
+## 📌 Table of Contents
 
-Bot qui permet d'être alerté des stocks de Nvidia RTX FE.
+- [✨ Features](#features)
+- [🐳 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)
+- [🧑‍💻 Contributors](#contributors)
 
-Ce robot :
-- Appelle l'API de Nvidia listant le produit (par défaut toutes les 60s)
-- Récupère le SKU du produit concerné
-- Appelle le stock lié à ce SKU
-- Si du stock est trouvé, envoie une notification discord via le webhook paramétré
-- Si le produit était déjà en stock, il n'envoie plus de notification
-- Si le produit était en stock mais ne l'est plus, envoie une notification discord signifiant la fin du stock
-- Si le SKU change, une notification est envoyée alertant de l'éventuelle imminence du drop
+## ✨ Features
 
-<img src="https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/nvbot.png" align="center">
+- Discord `@everyone` notification on SKU change (possible imminent drop)
+- Discord `@everyone` notification when stock is detected, including model, price, and link
+- Silent Discord notification when no stock is detected
+- Selectable check frequency
+- Selectable GPU model
 
-Trois modes d'installation :
-- [Avec le dépot Git et Docker](https://git.djeex.fr/Djeex/nvidia-stock-bot/#installation-avec-le-d%C3%A9pot)
-- [Sans le dépot Git et avec notre image docker fournie](https://git.djeex.fr/Djeex/nvidia-stock-bot/#installation-sans-le-d%C3%A9pot-avec-docker-compose)
-- [Avec python (développeurs)](https://git.djeex.fr/Djeex/nvidia-stock-bot/#installation-sans-le-d%C3%A9pot-avec-docker-compose)
+## 🐳 Docker Installation without the repo (quick)
 
-## Installation avec le dépot
+Below are the instructions to set up the container using our pre-built image. With this setup, your bot will run independently as long as the container is active.
 
-Vous trouverez-ci dessous les instructions pour installer le dépot, compiler l'image docker, et lancer le conteneur. Avec cette solution, votre bot tournera tout seul tant que le conteneur est actif.
+**Requirements**
+- [Docker](https://docs.docker.com/engine/install/)
 
-### Pré-requis
-- Git
-- Docker
+**Configuration**
 
-### Cloner et paramétrer
+- Create a folder named `nvidia-stock-bot`
+- Create a `compose.yaml` file inside that folder with the following content:
 
-Clonez le repo :
-```sh
-git clone https://git.djeex.fr/Djeex/nvidia-stock-bot.git
+```yaml
+services:
+  nvidia-stock-bot:
+    image: git.djeex.fr/djeex/nvidia-stock-bot:latest
+    container_name: nvidia-stock-bot
+    restart: unless-stopped
+    environment:
+      - DISCORD_WEBHOOK_URL= # Your Discord webhook URL
+      - PRODUCT_NAME=        # Exact GPU name like "RTX 5080"
+      - PYTHONUNBUFFERED=1   # Enables real-time log output
+    command: python nvidia-stock-bot.py
 ```
 
-Rendez vous dans le dossier `nvidia-stock-bot` et compilez l'image docker :
-```sh
-docker build -t nvidia-stock-bot .
-```
+**Environment Variables:**
 
-Rendez-vous dans le dossier `nvidia-stock-bot/docker` et éditez le fichier `.env` avec :
-- l'url de votre webhook discord
-- la fréquence de consultation des stock (par défaut 60s, attention à ne pas trop descendre sous peine de blocage de votre adresse IP par nVidia)
+| Variable            | Description                                     | Possible Values                                                  | Default Value                                                                                              |
+|---------------------|-------------------------------------------------|------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
+| DISCORD_WEBHOOK_URL | Your Discord webhook URL                        | A valid URL                                                      |                                                                                                             |
+| REFRESH_TIME        | Script refresh interval in seconds              | `60`, `30`, etc.                                                 | `30`                                                                                                        |
+| API_URL_SKU         | API listing the product                         | A URL                                                            | `https://api.nvidia.partners/edge/product/search?page=1&limit=100&locale=fr-fr&Manufacturer=Nvidia`         |
+| API_URL_STOCK       | API providing stock data                        | A URL                                                            | `https://api.store.nvidia.com/partner/v1/feinventory?locale=fr-fr&skus=`                                    |
+| PRODUCT_URL         | GPU purchase URL                                | A URL                                                            | `https://marketplace.nvidia.com/fr-fr/consumer/graphics-cards/?locale=fr-fr&page=1&limit=12&manufacturer=NVIDIA` |
+| PRODUCT_NAME        | The exact GPU name you're searching for         | `RTX 5090`, `RTX 5080`, `RTX 5070`                               |                                                                                                             |
+| TEST_MODE           | For testing without sending notifications       | `True`, `False`                                                  | `False`                                                                                                     |
+| PYTHONUNBUFFERED    | Enables real-time log output                    | `1`, `0`                                                         | `1`                                                                                                         |
 
-### Lancer l'image
+**Run the image**
 
-Rendez-vous dans le dossier `nvidia-stock-bot/docker` et lancez le conteneur :
+Navigate to the `nvidia-stock-bot` folder and launch the container:
 ```sh
 docker compose up -d
 ```
 
-### Voir les logs pour vérifier le bon fonctionnement
+**Check logs to verify operation**
 
 ```sh
 docker logs -f nvidia-stock-bot
 ```
 
-## Installation sans le dépot avec docker compose
+## 📦 Docker Installation with the repo
 
-Vous trouverez-ci dessous les instructions pour configurer le conteneur avec notre image pré-compilée. Avec cette solution, votre bot tournera tout seul tant que le conteneur est actif.
+Instructions below show how to install the repo, build the Docker image, and launch the container. Your bot will run independently as long as the container is active.
 
-### Pré-requis
-- Docker
+**Requirements**
+- [Git](https://git-scm.com/docs)
+- [Docker](https://docs.docker.com/engine/install/)
 
-### Configuration
+**Clone and configure**
 
-```yaml
-version: "3.8"
-services:
-  nvidia-stock-bot:
-    image: git.djeex.fr/djeex/nvidia-stock-bot:latest
-    container_name: nvidia-stock-bot
-    restart: always # Le conteneur redémarrera automatiquement en cas d'échec
-    environment:
-      - DISCORD_WEBHOOK_URL= # URL de votre webhook Discord
-      - REFRESH_TIME= # Durée de rafraichissement du script en secondes
-      - API_URL_SKU= # API listant le produit par exemple https://api.nvidia.partners/edge/product/search?page=1&limit=100&locale=fr-fr&Manufacturer=Nvidia&gpu=RTX%205090
-      - API_URL_STOCK= # API appelant le stock sans préciser la valeur du sku, par exemple https://api.store.nvidia.com/partner/v1/feinventory?locale=fr-fr&skus=
-      - PRODUCT_URL= # URL d'achat du GPU
-      - PRODUCT_NAME= #Le nom du GPU qui s'affiche dans les notifications
-      - TEST_MODE=  #true pour tester les notifications discord. false par défaut.
-      - PYTHONUNBUFFERED=1 # Permet d'afficher les logs en temps réel
-    command: python nvidia-stock-bot.py # Lance le script Python au démarrage du conteneur
+- Clone the repo:
+```sh
+git clone https://git.djeex.fr/Djeex/nvidia-stock-bot.git
 ```
 
-## Installation avec Python
+- Navigate to `nvidia-stock-bot` and build the Docker image:
+```sh
+docker build -t nvidia-stock-bot .
+```
 
-Vous trouverez ci-dessous comment exécuter directement le script Python. Avec cette solution, le bot s'arretera si vous fermez votre terminal.
+- Then go to `nvidia-stock-bot/docker` and edit the `.env` file with:
+  - Your Discord webhook URL
+  - The API and product URLs
+  - Stock checking frequency (default: 60s; lowering too much may get your IP blocked by Nvidia)
 
-### Pré-requis
+**Run the image**
 
-- Python 3.11 ou plus
-- requests : `pip install requests`
+Navigate to `nvidia-stock-bot/docker` and launch the container:
+```sh
+docker compose up -d
+```
 
-### Configuration
+**Check logs to verify operation**
 
-- Créez un environnement virtuel (exemple : `python3 -m venv nom_de_l_environnement` )
-- Créez un dossier et aller dedans
-- Téléchargez le script python :
-  
-  ```sh
-  curl -o nvidia-stock-bot.py -# https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/nvidia-stock-bot.py
-  ```
-- Exportez les variables d'environnement avec votre webhook discord et le temps de rafraichissement en secondes, par exemple :
-  
-  ```sh
-  export DISCORD_WEBHOOK_URL="https://votre_url_discord"
-  export REFRESH_TIME="60"
-  export API_URL_SKU="https://api.nvidia.partners/edge/product/search?page=1&limit=100&locale=fr-fr&Manufacturer=Nvidia&gpu=RTX%205080"
-  export API_URL_STOCK="https://api.store.nvidia.com/partner/v1/feinventory?locale=fr-fr&skus="
-  export PRODUCT_URL= "https://marketplace.nvidia.com/fr-fr/consumer/graphics-cards/?locale=fr-fr&page=1&limit=12&gpu=RTX%205080&manufacturer=NVIDIA"
-  export PRODUCT_NAME="RTX 5080"
-  export TEST_MODE=false
-  ```
-- Lancez le script
-  
-  ```sh
-  python nvidia-stock-bot.py
-  ```
+```sh
+docker logs -f nvidia-stock-bot
+```
+
+## 🐍 Python Installation
+
+Instructions to directly run the Python script. Note: the bot stops when you close the terminal.
+
+**Requirements**
+
+- Python 3.11 or newer
+- requests: `pip install requests`
+
+**Configuration**
+
+- Create a virtual environment (e.g., `python3 -m venv env_name`)
+- Create and navigate into a folder
+- Download the Python script:
+
+```sh
+curl -o nvidia-stock-bot.py -# https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/nvidia-stock-bot.py
+```
+
+- Export the environment variables with your webhook and refresh time:
+
+```sh
+export DISCORD_WEBHOOK_URL="https://your_discord_url"
+export REFRESH_TIME="60"
+export API_URL_SKU="https://api.nvidia.partners/edge/product/search?page=1&limit=100&locale=fr-fr&Manufacturer=Nvidia&gpu=RTX%205080"
+export API_URL_STOCK="https://api.store.nvidia.com/partner/v1/feinventory?locale=fr-fr&skus="
+export PRODUCT_URL="https://marketplace.nvidia.com/fr-fr/consumer/graphics-cards/?locale=fr-fr&page=1&limit=12&gpu=RTX%205080&manufacturer=NVIDIA"
+export PRODUCT_NAME="RTX 5080"
+export TEST_MODE=false
+```
+
+- Run the script
+
+```sh
+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>
+
+## 🧑‍💻 Contributors
+
+Thanks for their contributions:
+
+- Djeex
+- KevOut
+- Extreme2pac

docker/.env

@@ -1,6 +1,6 @@
-DS_HOOK= #votre url du webhook Discord
-FREQ= #frequence de rafraichissement en secondes
-API_URL_SKU= # API listant le produit par exemple https://api.nvidia.partners/edge/product/search?page=1&limit=100&locale=fr-fr&Manufacturer=Nvidia&gpu=RTX%205090
-API_URL_STOCK= # API appelant le stock sans préciser la valeur du sku, par exemple https://api.store.nvidia.com/partner/v1/feinventory?locale=fr-fr&skus=
-PRODUCT_URL= # URL d'achat du GPU
-PRODUCT_NAME= #Le nom du GPU qui s'affiche dans les notifications
+DS_HOOK=        # Your Discord webhook URL
+FREQ=           # Refresh frequency in seconds, default is 30
+API_URL_SKU=    # API listing the product, default is https://api.nvidia.partners/edge/product/search?page=1&limit=100&locale=fr-fr&Manufacturer=Nvidia
+API_URL_STOCK=  # API used to check stock without specifying the SKU, default is https://api.store.nvidia.com/partner/v1/feinventory?locale=fr-fr&skus=
+PRODUCT_URL=    # Purchase URL of the GPU
+PRODUCT_NAME=   # The exact name of the GPU you're looking for, e.g., "RTX 5080"

docker/compose.yaml

@@ -1,9 +1,8 @@
-version: "3.8"
 services:
   nvidia-stock-bot:
     image: nvidia-stock-bot
     container_name: nvidia-stock-bot
-    restart: always # Le conteneur redémarrera automatiquement en cas d'échec
+    restart: unless-stopped
     env_file:
       - .env
     environment:
@@ -11,5 +10,7 @@ services:
       - REFRESH_TIME=${FREQ}
       - API_URL_SKU=${API_URL_SKU}
       - API_URL_STOCK=${API_URL_STOCK}
-      - PYTHONUNBUFFERED=1 # Permet d'afficher les logs en temps réel
-    command: python nvidia-stock-bot.py # Lance le script Python
+      - PRODUCT_URL=${PRODUCT_URL}
+      - PRODUCT_NAME=${PRODUCT_NAME}
+      - PYTHONUNBUFFERED=1 # Allow to display log in real-time
+    command: python nvidia-stock-bot.py # Run the script

nvidia-stock-bot.py

@@ -5,56 +5,65 @@ import os
 import re
 from requests.adapters import HTTPAdapter, Retry
 
-# Configuration du logger
+# Logger configuration
 logging.basicConfig(
     level=logging.INFO,
     format="%(asctime)s [%(levelname)s] %(message)s",
 )
-logging.info("Démarrage du script")
+logging.info("Script started")
 
-# Récupération des variables d'environnement
+# Retrieve environment variables
 try:
-    DISCORD_WEBHOOK_URL = os.environ['DISCORD_WEBHOOK_URL']
-    API_URL_SKU = os.environ['API_URL_SKU']
-    API_URL_STOCK = os.environ['API_URL_STOCK']
-    REFRESH_TIME = int(os.environ['REFRESH_TIME'])  # Convertir en entier
+    DISCORD_WEBHOOK_URL = os.environ.get('DISCORD_WEBHOOK_URL')
+    API_URL_SKU = os.environ.get('API_URL_SKU', 'https://api.nvidia.partners/edge/product/search?page=1&limit=100&locale=fr-fr&Manufacturer=Nvidia')
+    API_URL_STOCK = os.environ.get('API_URL_STOCK', 'https://api.store.nvidia.com/partner/v1/feinventory?locale=fr-fr&skus=')
+    REFRESH_TIME = int(os.environ.get('REFRESH_TIME'))
     TEST_MODE = os.environ.get('TEST_MODE', 'False').lower() == 'true'
-    PRODUCT_URL = os.environ['PRODUCT_URL']
-    PRODUCT_NAME = os.environ['PRODUCT_NAME']
+    PRODUCT_URL = os.environ.get('PRODUCT_URL', 'https://marketplace.nvidia.com/fr-fr/consumer/graphics-cards/?locale=fr-fr&page=1&limit=12&manufacturer=NVIDIA')
+    PRODUCT_NAME = os.environ.get('PRODUCT_NAME')
     
-    # Regex pour extraire l'ID et le token
+    # Error logging
+    if not DISCORD_WEBHOOK_URL:
+        logging.error("❌ DISCORD_WEBHOOK_URL is required but not defined.")
+        exit(1)
+
+    if not PRODUCT_NAME:
+        logging.error("❌ PRODUCT_NAME is required but not defined.")
+        exit(1)
+
+    # Regex to extract ID and token
     match = re.search(r'/(\d+)/(.*)', DISCORD_WEBHOOK_URL)
     if match:
         webhook_id = match.group(1)
         webhook_token = match.group(2)
 
-        # Masquer derniers caractères de l'ID
+        # Mask last characters of the ID
         masked_webhook_id = webhook_id[:len(webhook_id) - 10] + '*' * 10
 
-        # Masquer derniers caractères du token
+        # Mask last characters of the token
         masked_webhook_token = webhook_token[:len(webhook_token) - 120] + '*' * 10
 
-        # Reconstruction de l'url masquée
+        # Rebuild masked URL
         wh_masked_url = f"https://discord.com/api/webhooks/{masked_webhook_id}/{masked_webhook_token}"
 
+# Error logging
 except KeyError as e:
-    logging.error(f"Variable d'environnement manquante : {e}")
+    logging.error(f"Missing environment variable: {e}")
     exit(1)
 except ValueError:
-    logging.error("REFRESH_TIME doit être un entier valide.")
+    logging.error("REFRESH_TIME must be a valid integer.")
     exit(1)
 
-# Affichage des URLs et configurations
+# Display URLs and configurations
 logging.info(f"GPU: {PRODUCT_NAME}")
-logging.info(f"URL Webhook Discord: {wh_masked_url}")
-logging.info(f"URL API SKU: {API_URL_SKU}")
-logging.info(f"URL API Stock: {API_URL_STOCK}")
-logging.info(f"URL produit: {PRODUCT_URL}")
-logging.info(f"Temps d'actualisation: {REFRESH_TIME} secondes")
-logging.info(f"Mode Test: {TEST_MODE}")
+logging.info(f"Discord Webhook URL: {wh_masked_url}")
+logging.info(f"API URL SKU: {API_URL_SKU}")
+logging.info(f"API URL Stock: {API_URL_STOCK}")
+logging.info(f"Product URL: {PRODUCT_URL}")
+logging.info(f"Refresh time: {REFRESH_TIME} seconds")
+logging.info(f"Test Mode: {TEST_MODE}")
 
-
-# Entêtes HTTP
+# HTTP headers
 HEADERS = {
     "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) "
                   "AppleWebKit/537.36 (KHTML, like Gecko) "
@@ -73,30 +82,30 @@ HEADERS = {
     "Sec-GPC": "1",
 }
 
-# Session avec retries
+# Session with retries
 session = requests.Session()
 retries = Retry(total=5, backoff_factor=1, status_forcelist=[500, 502, 503, 504])
 session.mount('https://', HTTPAdapter(max_retries=retries))
 
-# Stockage de l'état des stocks
+# Store stock status
 global_stock_status = {}
 
-# Stocke le dernier SKU connu
+# Store the last known SKU
 last_sku = None
 first_run = True  # Before calling check_rtx_50_founders
 
-# Notifications Discord
+# Discord notifications
 def send_discord_notification(gpu_name: str, product_link: str, products_price: str):
     
-    # Récupérer le timestamp UNIX actuel
+    # Get current UNIX timestamp
     timestamp_unix = int(time.time())
 
     if TEST_MODE:
-        logging.info(f"[TEST MODE] Notification Discord: {gpu_name} disponible !")
+        logging.info(f"[TEST MODE] Discord Notification: {gpu_name} available!")
         return
     
     embed = {
-        "title": f"🚀 {PRODUCT_NAME} EN STOCK !",
+        "title": f"🚀 {PRODUCT_NAME} IN STOCK!",
         "color": 3066993,
         "thumbnail": {
             "url": "https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/RTX5000.jpg"
@@ -107,44 +116,45 @@ def send_discord_notification(gpu_name: str, product_link: str, products_price:
 
         "fields": [
             {
-            "name": "Prix",
+            "name": "Price",
             "value": f"`{products_price}€`",
             "inline": True
             },
 
             {
-            "name": "Heure",
+            "name": "Time",
             "value": f"<t:{timestamp_unix}:d> <t:{timestamp_unix}:T>",
             "inline": True
             },
         ],
-        "description": f"**:point_right: [Acheter maintenant]({product_link})**",
+        "description": f"**:point_right: [Buy now]({product_link})**",
         "footer": {
-            "text": "Par KevOut & Djeex"
+            "text": "NviBot • JV Hardware 2.0",
+            "icon_url": "https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/ds_wh_pp.jpg"
         }
     }
-    payload = {"content": "@everyone", "username": "NviBot", "avatar_url": "https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/RTX5000_pp.jpg", "embeds": [embed]}
+    payload = {"content": "@everyone", "username": "NviBot", "avatar_url": "https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/ds_wh_pp.jpg", "embeds": [embed]}
     try:
         response = requests.post(DISCORD_WEBHOOK_URL, json=payload)
         if response.status_code == 204:
-            logging.info("✅ Notification envoyée sur Discord.")
+            logging.info("✅ Notification sent to Discord.")
         else:
-            logging.error(f"❌ Erreur Webhook : {response.status_code} - {response.text}")
+            logging.error(f"❌ Webhook error: {response.status_code} - {response.text}")
     except Exception as e:
-        logging.error(f"🚨 Erreur lors de l'envoi du webhook : {e}")
+        logging.error(f"🚨 Error sending webhook: {e}")
 
 def send_out_of_stock_notification(gpu_name: str, product_link: str, products_price: str):
     
-    # Récupérer le timestamp UNIX actuel
+    # Get current UNIX timestamp
     timestamp_unix = int(time.time())
 
     if TEST_MODE:
-        logging.info(f"[TEST MODE] Notification Discord: {gpu_name} hors stock !")
+        logging.info(f"[TEST MODE] Discord Notification: {gpu_name} out of stock!")
         return
     
     embed = {
-        "title": f"❌ {PRODUCT_NAME} n'est plus en stock",
-        "color": 15158332,  # Rouge pour hors stock
+        "title": f"❌ {PRODUCT_NAME} is out of stock",
+        "color": 15158332,  # Red for out of stock
         "thumbnail": {
             "url": "https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/RTX5000.jpg"
         },
@@ -152,50 +162,53 @@ def send_out_of_stock_notification(gpu_name: str, product_link: str, products_pr
         "author": {
             "name": "Nvidia Founder Editions"
         },
+        
         "footer": {
-            "text": "Par KevOut & Djeex"
+            "text": "NviBot • JV Hardware 2.0",
+            "icon_url": "https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/ds_wh_pp.jpg"
         },
 
         "fields": [
             {
-            "name": "Heure",
+            "name": "Time",
             "value": f"<t:{timestamp_unix}:d> <t:{timestamp_unix}:T>",
             "inline": True
             }
         ]
     }
-    payload = {"username": "NviBot", "avatar_url": "https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/RTX5000_pp.jpg", "embeds": [embed]}
+    payload = {"username": "NviBot", "avatar_url": "https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/ds_wh_pp.jpg", "embeds": [embed]}
     try:
         response = requests.post(DISCORD_WEBHOOK_URL, json=payload)
         if response.status_code == 204:
-            logging.info("✅ Notification 'hors stock' envoyée sur Discord.")
+            logging.info("✅ 'Out of stock' notification sent to Discord.")
         else:
-            logging.error(f"❌ Erreur Webhook : {response.status_code} - {response.text}")
+            logging.error(f"❌ Webhook error: {response.status_code} - {response.text}")
     except Exception as e:
-        logging.error(f"🚨 Erreur lors de l'envoi du webhook : {e}")
+        logging.error(f"🚨 Error sending webhook: {e}")
 
 def send_sku_change_notification(old_sku: str, new_sku: str, product_link: str):
     
-    # Récupérer le timestamp UNIX actuel
+    # Get current UNIX timestamp
     timestamp_unix = int(time.time())
 
     if TEST_MODE:
-        logging.info(f"[TEST MODE] Changement de SKU détecté : {old_sku} → {new_sku}")
+        logging.info(f"[TEST MODE] SKU change detected: {old_sku} → {new_sku}")
         return
 
     embed = {
-        "title": f"🔄 {PRODUCT_NAME} Changement de SKU détecté",
+        "title": f"🔄 {PRODUCT_NAME} SKU change detected",
         "url": f"{product_link}",
-        "description": f"**Ancien SKU** : `{old_sku}`\n**Nouveau SKU** : `{new_sku}`",
-        "color": 16776960,  # Jaune
+        "description": f"**Old SKU** : `{old_sku}`\n**New SKU** : `{new_sku}`",
+        "color": 16776960,  # Yellow
 
         "footer": {
-            "text": "Par KevOut & Djeex"
+            "text": "NviBot • JV Hardware 2.0",
+            "icon_url": "https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/ds_wh_pp.jpg"
         },
 
         "fields": [
             {
-            "name": "Heure",
+            "name": "Time",
             "value": f"<t:{timestamp_unix}:d> <t:{timestamp_unix}:T>",
             "inline": True
             }
@@ -203,85 +216,97 @@ def send_sku_change_notification(old_sku: str, new_sku: str, product_link: str):
     }
     
     payload = {
-        "content": "@everyone ⚠️ Potentiel drop imminent !",
+        "content": "@everyone ⚠️ Possible imminent drop!",
         "username": "NviBot",
-        "avatar_url": "https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/RTX5000_pp.jpg",
+        "avatar_url": "https://git.djeex.fr/Djeex/nvidia-stock-bot/raw/branch/main/assets/img/ds_wh_pp.jpg",
         "embeds": [embed]
     }
     
     try:
         response = requests.post(DISCORD_WEBHOOK_URL, json=payload)
         if response.status_code == 204:
-            logging.info("✅ Notification de changement de SKU envoyée sur Discord.")
+            logging.info("✅ SKU change notification sent to Discord.")
         else:
-            logging.error(f"❌ Erreur Webhook : {response.status_code} - {response.text}")
+            logging.error(f"❌ Webhook error: {response.status_code} - {response.text}")
     except Exception as e:
-        logging.error(f"🚨 Erreur lors de l'envoi du webhook : {e}")
+        logging.error(f"🚨 Error sending webhook: {e}")
 
-# Recherche du stock
+# Stock search
 def check_rtx_50_founders():
     global global_stock_status, last_sku, first_run
 
-    # Appel vers l'API produit pour récupérer le sku et l'upc
-
+    # Call product API to retrieve SKU and UPC
     try:
         response = session.get(API_URL_SKU, headers=HEADERS, timeout=10)
-        logging.info(f"Réponse de l'API SKU : {response.status_code}")
+        logging.info(f"SKU API response: {response.status_code}")
         response.raise_for_status()
         data = response.json()
     except requests.exceptions.RequestException as e:
-        logging.error(f"Erreur API SKU : {e}")
+        logging.error(f"SKU API error: {e}")
         return
 
-    product_details = data['searchedProducts']['productDetails'][0]
-    product_sku = product_details['productSKU']
+   # Look for product whose GPU matches PRODUCT_NAME
+    product_details = None
 
-    # Vérifier si c'est la première exécution
-    if last_sku is not None and product_sku != last_sku:
-        if not first_run:  # Évite d'envoyer une notification au premier appel
-            product_link = PRODUCT_URL
-            logging.warning(f"⚠️ SKU modifié : {last_sku} → {product_sku}")
-            send_sku_change_notification(last_sku, product_sku, product_link)
+    for p in data['searchedProducts']['productDetails']:
+        gpu_name = p.get("gpu", "").strip()
+        
+        # If the GPU matches exactly PRODUCT_NAME
+        if gpu_name == PRODUCT_NAME.strip():
+            product_details = p
+            break  # Exit as soon as the correct product is found
 
-    # Mettre à jour le SKU stocké
-    last_sku = product_sku
-    first_run = False  # Désactive la protection après la première exécution
+    if not product_details:
+        logging.warning(f"⚠️ No product with GPU '{PRODUCT_NAME}' found.")
+        return
 
-    product_details = data['searchedProducts']['productDetails'][0]
+    # Retrieve the SKU for the found GPU
     product_sku = product_details['productSKU']
     product_upc = product_details.get('productUPC', "")
+
+    # Check if this is the first execution
+    if last_sku is not None and product_sku != last_sku:
+        if not first_run:  # Prevent sending notification on first run
+            product_link = PRODUCT_URL
+            logging.warning(f"⚠️ SKU changed: {last_sku} → {product_sku}")
+            send_sku_change_notification(last_sku, product_sku, product_link)
+
+    # Update stored SKU
+    last_sku = product_sku
+    first_run = False  # Disable first-run protection
+
     if not isinstance(product_upc, list):
         product_upc = [product_upc]
     
-    # Construction de l'url de l'API de stock et appel pour vérifier le statut
+    # Build stock API URL and call to check status
     API_URL = API_URL_STOCK + product_sku
-    logging.info(f"URL de l'API de stock appelée : {API_URL}")
+    logging.info(f"Stock API URL called: {API_URL}")
     
     try:
         response = session.get(API_URL, headers=HEADERS, timeout=10)
-        logging.info(f"Réponse de l'API : {response.status_code}")  
+        logging.info(f"Stock API response: {response.status_code}")  
         response.raise_for_status()
         data = response.json()
     except requests.exceptions.RequestException as e:
-        logging.error(f"Erreur API Stock : {e}")
+        logging.error(f"Stock API error: {e}")
         return
 
     products = data.get("listMap", [])
-    products_price = 'Prix non disponible'  # Valeur par défaut
+    products_price = 'Price not available'  # Default value
 
-    # Vérification de la liste des produits et récupération du prix
+    # Check product list and retrieve price
     if isinstance(products, list) and len(products) > 0:
         for product in products:
-            price = product.get("price", 'Prix non disponible')
-            if price != 'Prix non disponible':
-                products_price = price  # Utiliser le prix trouvé
-                break  # Sortir dès qu'on trouve un prix
+            price = product.get("price", 'Price not available')
+            if price != 'Price not available':
+                products_price = price  # Use found price
+                break  # Stop at first found price
     else:
-        logging.error("La liste des produits est vide ou mal formée.")
+        logging.error("Product list is empty or malformed.")
 
     found_in_stock = set()
 
-    # Recherche du statut et notifications selon le statut
+    # Check status and send notifications accordingly
     for p in products:
         gpu_name = p.get("fe_sku", "").upper()
         is_active = p.get("is_active") == "true"
@@ -297,20 +322,18 @@ def check_rtx_50_founders():
             product_link = PRODUCT_URL
             send_discord_notification(gpu_upper, product_link, products_price)
             global_stock_status[gpu_upper] = True
-            logging.info(f"{gpu} est maintenant en stock!")
+            logging.info(f"{gpu} is now in stock!")
         elif not currently_in_stock and previously_in_stock:
             product_link = PRODUCT_URL
             send_out_of_stock_notification(gpu_upper, product_link, products_price)
             global_stock_status[gpu_upper] = False
-            logging.info(f"{gpu} n'est plus en stock.")
-
+            logging.info(f"{gpu} is no longer in stock.")
         elif currently_in_stock and previously_in_stock:
-            logging.info(f"{gpu} est actuellement en stock.")
-            
+            logging.info(f"{gpu} is currently in stock.")
         else:
-            logging.info(f"{gpu} est actuellement hors stock.")
+            logging.info(f"{gpu} is currently out of stock.")
 
-# Boucle
+# Loop
 if __name__ == "__main__":
     while True:
         check_rtx_50_founders()