cs2tracker 2.1.14__py3-none-any.whl → 2.1.16__py3-none-any.whl

cs2tracker/data/get_inventory.js

@@ -22,15 +22,24 @@ const password = args[8];
 const twoFactorCode = args[9];
 
 const paddedLog = (...args) => {
-  console.log(" [+] ", ...args);
+  console.log(" [INFO] ", ...args);
 };
 
 const originalConsoleError = console.error;
 console.error = (...args) => {
-  originalConsoleError("    [!] " + args.join(" "));
+  originalConsoleError(" [ERROR] " + args.join(" "));
 };
 
 (async () => {
+  const closeWithError = (message) => {
+    console.error(message);
+    console.error("This window will automatically close in 10 seconds.");
+    setTimeout(() => {
+      user.logOff();
+      process.exit(1);
+    }, 10000);
+  };
+
   let user = new SteamUser();
 
   paddedLog("Logging into Steam...");
@@ -41,25 +50,36 @@ console.error = (...args) => {
     twoFactorCode: twoFactorCode,
   });
 
-  user.on("error", (err) => {
-    console.error("Steam Error: " + err);
-    user.logOff();
-    process.exit(1);
+  const LOGIN_TIMEOUT_MS = 15000;
+  let loginTimeout = setTimeout(() => {
+    closeWithError(
+      "Login timed out. Please check your credentials and try again.",
+    );
+  }, LOGIN_TIMEOUT_MS);
+
+  user.on("steamGuard", (_domain, _callback, lastCodeWrong) => {
+    if (lastCodeWrong) {
+      closeWithError(
+        "The Steam Guard code you entered was incorrect. Please try again.",
+      );
+    }
   });
 
   user.on("loggedOn", (_details, _parental) => {
+    clearTimeout(loginTimeout);
     paddedLog("Logged into Steam.");
     user.gamesPlayed([730]);
+    paddedLog("Connecting to CS2 Game Coordinator...");
   });
 
-  let cs2 = new CS2(user);
+  user.on("error", (err) => {
+    closeWithError(`Steam Error: ${err.message}`);
+  });
 
-  paddedLog("Connecting to CS2 Game Coordinator...");
+  let cs2 = new CS2(user);
 
   cs2.on("error", (err) => {
-    console.error("CS2 Error: " + err);
-    user.logOff();
-    process.exit(1);
+    closeWithError(`CS2 Error: ${err.message}`);
   });
 
   let nameConverter = new ItemNameConverter();
@@ -96,8 +116,6 @@ console.error = (...args) => {
     process.exit(0);
   });
 
-  // TODO: The inventory may contain items that are not marketable or tradable,
-  // so we have to make sure to process these items correctly in the main app.
   async function processInventory() {
     try {
       // filter out items that have the casket_id property set from the inventory
@@ -165,6 +183,9 @@ console.error = (...args) => {
   function filterItems(items) {
     let filteredItems = [];
     items.forEach((item) => {
+      if (!item.item_tradable) {
+        return;
+      }
       if (
         (item.item_type === "case" && importCases) ||
         (item.item_type === "sticker capsule" && importStickerCapsules) ||

cs2tracker/logs.py

@@ -0,0 +1,143 @@
+import csv
+from datetime import datetime
+
+from cs2tracker.config import get_config
+from cs2tracker.constants import OUTPUT_FILE
+from cs2tracker.scraper.parser import Parser
+from cs2tracker.util.currency_conversion import convert, to_symbol
+
+config = get_config()
+
+
+class PriceLogs:
+    @classmethod
+    def _append_latest_calculation(cls, date, usd_totals):
+        """Append the first price calculation of the day."""
+        with open(OUTPUT_FILE, "a", newline="", encoding="utf-8") as price_logs:
+            price_logs_writer = csv.writer(price_logs)
+            price_entries_today = [f"{usd_total:.2f}$" for usd_total in usd_totals]
+            price_logs_writer.writerow([date] + price_entries_today)
+
+    @classmethod
+    def _replace_latest_calculation(cls, date, usd_totals):
+        """Replace the last calculation of today with the most recent one of today."""
+        with open(OUTPUT_FILE, "r+", newline="", encoding="utf-8") as price_logs:
+            price_logs_reader = csv.reader(price_logs)
+            rows = list(price_logs_reader)
+            rows_without_today = rows[:-1]
+            price_logs.seek(0)
+            price_logs.truncate()
+
+            price_logs_writer = csv.writer(price_logs)
+            price_logs_writer.writerows(rows_without_today)
+            price_entries_today = [f"{usd_total:.2f}$" for usd_total in usd_totals]
+            price_logs_writer.writerow([date] + price_entries_today)
+
+    @classmethod
+    def save(cls, usd_totals):
+        """
+        Save the current date and total prices in USD to a CSV file.
+
+        This will append a new entry to the output file if no entry has been made for
+        today.
+
+        :param usd_totals: The total prices in USD to save.
+        :raises FileNotFoundError: If the output file does not exist.
+        :raises IOError: If there is an error writing to the output file.
+        """
+        with open(OUTPUT_FILE, "r", encoding="utf-8") as price_logs:
+            price_logs_reader = csv.reader(price_logs)
+            rows = list(price_logs_reader)
+            last_log_date = rows[-1][0] if rows else ""
+
+        today = datetime.now().strftime("%Y-%m-%d")
+        if last_log_date != today:
+            cls._append_latest_calculation(today, usd_totals)
+        else:
+            cls._replace_latest_calculation(today, usd_totals)
+
+    @classmethod
+    def read(cls, newest_first=False, with_symbols=False):
+        """
+        Parse the output file to extract dates, dollar prices, and the converted
+        currency prices. This data is used for drawing the plot of past prices.
+
+        :param newest_first: If True, the dates and totals will be returned in reverse
+            order
+        :param with_symbols: If True, the prices will be formatted with currency symbols
+        :return: A tuple containing dates and a dictionary of totals for each price
+            source.
+        :raises FileNotFoundError: If the output file does not exist.
+        :raises IOError: If there is an error reading the output file.
+        """
+        conversion_currency = config.conversion_currency
+        dates = []
+        totals = {
+            price_source: {"USD": [], conversion_currency: []} for price_source in Parser.SOURCES
+        }
+
+        with open(OUTPUT_FILE, "r", encoding="utf-8") as price_logs:
+            price_logs_reader = csv.reader(price_logs)
+            for row in price_logs_reader:
+                date, *usd_totals = row
+                date = datetime.strptime(date, "%Y-%m-%d")
+
+                usd_totals = [float(price_usd.rstrip("$")) for price_usd in usd_totals]
+                converted_totals = [
+                    convert(price_usd, "USD", conversion_currency) for price_usd in usd_totals
+                ]
+
+                dates.append(date)
+                for price_source_index, price_source in enumerate(Parser.SOURCES):
+                    totals[price_source]["USD"].append(usd_totals[price_source_index])
+                    totals[price_source][conversion_currency].append(
+                        converted_totals[price_source_index]
+                    )
+
+        if newest_first:
+            dates.reverse()
+            for price_source in Parser.SOURCES:
+                totals[price_source]["USD"].reverse()
+                totals[price_source][conversion_currency].reverse()
+
+        if with_symbols:
+            for price_source in Parser.SOURCES:
+                totals[price_source]["USD"] = [
+                    f"${price:.2f}" for price in totals[price_source]["USD"]
+                ]
+                totals[price_source][conversion_currency] = [
+                    f"{to_symbol(conversion_currency)}{price:.2f}"
+                    for price in totals[price_source][conversion_currency]
+                ]
+
+        return dates, totals
+
+    @classmethod
+    def validate_file(cls, log_file_path):
+        # pylint: disable=expression-not-assigned
+        """
+        Ensures that the provided price log file has the right format. This should be
+        used before importing a price log file to ensure it is valid.
+
+        :param log_file_path: The path to the price log file to validate.
+        :return: True if the price log file is valid, False otherwise.
+        """
+        try:
+            with open(log_file_path, "r", encoding="utf-8") as price_logs:
+                price_logs_reader = csv.reader(price_logs)
+                for row in price_logs_reader:
+                    date_str, *usd_totals = row
+                    datetime.strptime(date_str, "%Y-%m-%d")
+                    [float(price_usd.rstrip("$")) for price_usd in usd_totals]
+        except (FileNotFoundError, IOError, ValueError, TypeError):
+            return False
+        except Exception:
+            return False
+
+        return True
+
+    @classmethod
+    def empty(cls):
+        """Checks if the price history is empty and returns True if it is."""
+        with open(OUTPUT_FILE, "r", encoding="utf-8") as price_logs:
+            return len(list(price_logs)) == 0

cs2tracker/main.py

@@ -2,10 +2,10 @@ import sys
 
 import urllib3
 
-from cs2tracker.app import Application
+from cs2tracker.app.app import Application
 from cs2tracker.constants import AUTHOR_STRING, BANNER, OS, OSType
-from cs2tracker.scraper import Scraper
-from cs2tracker.util import get_console
+from cs2tracker.scraper.scraper import Scraper
+from cs2tracker.util.padded_console import get_console
 
 
 def main():

cs2tracker/scraper/__init__.py

@@ -1,9 +0,0 @@
-from cs2tracker.scraper.background_task import (  # noqa: F401 # pylint:disable=unused-import
-    BackgroundTask,
-)
-from cs2tracker.scraper.discord_notifier import (  # noqa: F401 # pylint:disable=unused-import
-    DiscordNotifier,
-)
-from cs2tracker.scraper.scraper import (  # noqa: F401 # pylint:disable=unused-import
-    Scraper,
-)

cs2tracker/scraper/background_task.py

@@ -1,5 +1,5 @@
 import os
-from subprocess import DEVNULL, call
+from subprocess import DEVNULL, STDOUT, CalledProcessError, call, check_output, run
 
 from cs2tracker.constants import (
     BATCH_FILE,
@@ -9,7 +9,7 @@ from cs2tracker.constants import (
     RUNNING_IN_EXE,
     OSType,
 )
-from cs2tracker.util import get_console
+from cs2tracker.util.padded_console import get_console
 
 WIN_BACKGROUND_TASK_NAME = "CS2Tracker Daily Calculation"
 WIN_BACKGROUND_TASK_SCHEDULE = "DAILY"
@@ -18,6 +18,18 @@ WIN_BACKGROUND_TASK_CMD = (
     f"powershell -WindowStyle Hidden -Command \"Start-Process '{BATCH_FILE}' -WindowStyle Hidden\""
 )
 
+LINUX_BACKGROUND_TASK_SCHEDULE = "0 12 * * *"
+LINUX_BACKGROUND_TASK_CMD = (
+    f"bash -c 'cd {PROJECT_DIR} && {PYTHON_EXECUTABLE} -m cs2tracker --only-scrape'"
+)
+LINUX_BACKGROUND_TASK_CMD_EXE = f"bash -c 'cd {PROJECT_DIR} && {PYTHON_EXECUTABLE} --only-scrape'"
+
+if RUNNING_IN_EXE:
+    LINUX_CRON_JOB = f"{LINUX_BACKGROUND_TASK_SCHEDULE} {LINUX_BACKGROUND_TASK_CMD_EXE}"
+else:
+    LINUX_CRON_JOB = f"{LINUX_BACKGROUND_TASK_SCHEDULE} {LINUX_BACKGROUND_TASK_CMD}"
+
+
 console = get_console()
 
 
@@ -34,8 +46,17 @@ class BackgroundTask:
             return_code = call(cmd, stdout=DEVNULL, stderr=DEVNULL)
             found = return_code == 0
             return found
+        elif OS == OSType.LINUX:
+            try:
+                existing_jobs = (
+                    check_output(["crontab", "-l"], stderr=STDOUT).decode("utf-8").strip()
+                )
+            except CalledProcessError:
+                existing_jobs = ""
+
+            found = LINUX_CRON_JOB in existing_jobs.splitlines()
+            return found
         else:
-            # TODO: implement finder for cron jobs
             return False
 
     @classmethod
@@ -83,17 +104,69 @@ class BackgroundTask:
             ]
             return_code = call(cmd, stdout=DEVNULL, stderr=DEVNULL)
             if return_code == 0:
-                console.print("[bold green][+] Background task enabled.")
+                console.info("Background task enabled.")
             else:
                 console.error("Failed to enable background task.")
         else:
             cmd = ["schtasks", "/delete", "/tn", WIN_BACKGROUND_TASK_NAME, "/f"]
             return_code = call(cmd, stdout=DEVNULL, stderr=DEVNULL)
             if return_code == 0:
-                console.print("[bold green][-] Background task disabled.")
+                console.info("Background task disabled.")
             else:
                 console.error("Failed to disable background task.")
 
+    @classmethod
+    def _toggle_linux(cls, enabled: bool):
+        """
+        Create or delete a daily background task that runs the scraper on Linux.
+
+        :param enabled: If True, the task will be created; if False, the task will be
+            deleted.
+        """
+        try:
+            existing_jobs = check_output(["crontab", "-l"], stderr=STDOUT).decode("utf-8").strip()
+        except CalledProcessError:
+            existing_jobs = ""
+
+        cron_lines = existing_jobs.splitlines()
+
+        if enabled and LINUX_CRON_JOB not in cron_lines:
+            updated_jobs = (
+                existing_jobs + "\n" + LINUX_CRON_JOB + "\n"
+                if existing_jobs
+                else LINUX_CRON_JOB + "\n"
+            )
+            try:
+                run(
+                    ["crontab", "-"],
+                    input=updated_jobs.encode("utf-8"),
+                    stdout=DEVNULL,
+                    stderr=DEVNULL,
+                    check=True,
+                )
+                console.info("Background task enabled.")
+            except CalledProcessError:
+                console.error("Failed to enable background task.")
+
+        elif not enabled and LINUX_CRON_JOB in cron_lines:
+            updated_jobs = "\n".join(
+                line for line in cron_lines if line.strip() != LINUX_CRON_JOB
+            ).strip()
+            try:
+                if updated_jobs:
+                    run(
+                        ["crontab", "-"],
+                        input=(updated_jobs + "\n").encode("utf-8"),
+                        stdout=DEVNULL,
+                        stderr=DEVNULL,
+                        check=True,
+                    )
+                else:
+                    run(["crontab", "-r"], stdout=DEVNULL, stderr=DEVNULL, check=True)
+                console.info("Background task disabled.")
+            except CalledProcessError:
+                console.error("Failed to disable background task.")
+
     @classmethod
     def toggle(cls, enabled: bool):
         """
@@ -104,6 +177,7 @@ class BackgroundTask:
         """
         if OS == OSType.WINDOWS:
             cls._toggle_windows(enabled)
+        elif OS == OSType.LINUX:
+            cls._toggle_linux(enabled)
         else:
-            # TODO: implement toggle for cron jobs
             pass

cs2tracker/scraper/discord_notifier.py

@@ -1,13 +1,16 @@
 import requests
 from requests.exceptions import RequestException
 
-from cs2tracker.util import PriceLogs, get_console
+from cs2tracker.config import get_config
+from cs2tracker.logs import PriceLogs
+from cs2tracker.util.padded_console import get_console
 
 DC_WEBHOOK_USERNAME = "CS2Tracker"
 DC_WEBHOOK_AVATAR_URL = "https://img.icons8.com/?size=100&id=uWQJp2tLXUH6&format=png&color=000000"
 DC_RECENT_HISTORY_LIMIT = 5
 
 console = get_console()
+config = get_config()
 
 
 class DiscordNotifier:
@@ -19,42 +22,41 @@ class DiscordNotifier:
 
         :return: A list of embeds for the Discord message.
         """
-        dates, usd_prices, eur_prices = PriceLogs.read()
-        dates, usd_prices, eur_prices = reversed(dates), reversed(usd_prices), reversed(eur_prices)
+        dates, totals = PriceLogs.read(newest_first=True, with_symbols=True)
 
-        date_history, usd_history, eur_history = [], [], []
-        for date, usd_log, eur_log in zip(dates, usd_prices, eur_prices):
-            if len(date_history) >= DC_RECENT_HISTORY_LIMIT:
-                break
-            date_history.append(date.strftime("%Y-%m-%d"))
-            usd_history.append(f"${usd_log:.2f}")
-            eur_history.append(f"€{eur_log:.2f}")
-
-        date_history = "\n".join(date_history)
-        usd_history = "\n".join(usd_history)
-        eur_history = "\n".join(eur_history)
+        date_field = [
+            {
+                "name": "Date",
+                "value": "\n".join([date.strftime("%Y-%m-%d") for date in dates][:DC_RECENT_HISTORY_LIMIT]),  # type: ignore
+                "inline": True,
+            },
+        ]
+        price_fields = [
+            {
+                "name": f"{price_source.name.title()} (USD | {config.conversion_currency})",
+                "value": "\n".join(
+                    [
+                        f"{usd_total} | {converted_total}"
+                        for usd_total, converted_total in zip(
+                            totals[price_source]["USD"][:DC_RECENT_HISTORY_LIMIT],
+                            totals[price_source][config.conversion_currency][
+                                :DC_RECENT_HISTORY_LIMIT
+                            ],
+                        )
+                    ]
+                ),
+                "inline": True,
+            }
+            for price_source in totals
+        ][
+            :2
+        ]  # Limit to the first two price sources because Discord can only display 3 fields per line (Date + 2 Price Sources)
 
         embeds = [
             {
-                "title": "📊 Recent Price History",
+                "title": "📊 Recent Investment History",
                 "color": 5814783,
-                "fields": [
-                    {
-                        "name": "Date",
-                        "value": date_history,
-                        "inline": True,
-                    },
-                    {
-                        "name": "USD Total",
-                        "value": usd_history,
-                        "inline": True,
-                    },
-                    {
-                        "name": "EUR Total",
-                        "value": eur_history,
-                        "inline": True,
-                    },
-                ],
+                "fields": date_field + price_fields,
             }
         ]
 

cs2tracker/scraper/{parsers.py → parser.py}

@@ -5,9 +5,9 @@ from urllib.parse import unquote
 from bs4 import BeautifulSoup
 from bs4.element import Tag
 
+from cs2tracker.config import get_config
 from cs2tracker.constants import CAPSULE_PAGES
-from cs2tracker.util import get_console
-from cs2tracker.util.validated_config import get_config
+from cs2tracker.util.padded_console import get_console
 
 config = get_config()
 console = get_console()
@@ -17,9 +17,11 @@ class PriceSource(Enum):
     STEAM = "steam"
     BUFF163 = "buff163"
     SKINPORT = "skinport"
+    YOUPIN898 = "youpin"
+    CSFLOAT = "csfloat"
 
 
-class Parser(ABC):
+class BaseParser(ABC):
     @classmethod
     @abstractmethod
     def get_item_page_url(cls, item_href, source=PriceSource.STEAM) -> str:
@@ -46,7 +48,7 @@ class Parser(ABC):
         """
 
 
-class SteamParser(Parser):
+class SteamParser(BaseParser):
     STEAM_MARKET_SEARCH_PAGE_BASE_URL = "https://steamcommunity.com/market/search?q={}"
     PRICE_INFO = "Owned: {:<10}  {} price: ${:<10}  Total: ${:<10}"
     NEEDS_TIMEOUT = True
@@ -60,7 +62,7 @@ class SteamParser(Parser):
         # Therefore, if the provided item is a sticker capsule we return a search page defined in CAPSULE_PAGES
         # where all of the sticker capsules of one section are listed
         for section in config.sections():
-            if section in ("Custom Items", "Cases", "User Settings", "App Settings"):
+            if section in ("Skins", "Stickers", "Cases", "User Settings", "App Settings"):
                 continue
             if any(item_href == option for option in config.options(section)):
                 return CAPSULE_PAGES[section]
@@ -89,24 +91,7 @@ class SteamParser(Parser):
         return price
 
 
-class SkinLedgerParser(Parser):
-    SKINLEDGER_PRICE_LIST = ""
-    PRICE_INFO = "Owned: {:<10}  {} price: ${:<10}  Total: ${:<10}"
-    NEEDS_TIMEOUT = False
-    SOURCES = [PriceSource.STEAM, PriceSource.BUFF163, PriceSource.SKINPORT]
-
-    @classmethod
-    def get_item_page_url(cls, item_href, source=PriceSource.STEAM) -> str:
-        _ = source
-        return super().get_item_page_url(item_href)
-
-    @classmethod
-    def parse_item_price(cls, item_page, item_href, source=PriceSource.STEAM) -> float:
-        _, _ = item_href, source
-        return super().parse_item_price(item_page, item_href)
-
-
-class ClashParser(Parser):
+class ClashParser(BaseParser):
     CLASH_ITEM_API_BASE_URL = "https://inventory.clash.gg/api/GetItemPrice?id={}"
     PRICE_INFO = "Owned: {:<10}  {} price: ${:<10}  Total: ${:<10}"
     NEEDS_TIMEOUT = True
@@ -138,11 +123,11 @@ class ClashParser(Parser):
         return price
 
 
-class CSGOTrader(Parser):
+class CSGOTraderParser(BaseParser):
     CSGOTRADER_PRICE_LIST = "https://prices.csgotrader.app/latest/{}.json"
     PRICE_INFO = "Owned: {:<10}  {:<10}: ${:<10}  Total: ${:<10}"
     NEEDS_TIMEOUT = False
-    SOURCES = [PriceSource.STEAM, PriceSource.BUFF163, PriceSource.SKINPORT]
+    SOURCES = [PriceSource.STEAM, PriceSource.BUFF163, PriceSource.CSFLOAT]
 
     @classmethod
     def get_item_page_url(cls, item_href, source=PriceSource.STEAM):
@@ -154,6 +139,7 @@ class CSGOTrader(Parser):
 
     @classmethod
     def parse_item_price(cls, item_page, item_href, source=PriceSource.STEAM):
+        # pylint: disable=too-many-branches
         _ = source
 
         price_list = item_page.json()
@@ -167,13 +153,14 @@ class CSGOTrader(Parser):
             raise ValueError(f"CSGOTrader: Could not find item price info: {url_decoded_name}")
 
         if source == PriceSource.STEAM:
-            price = price_info.get("last_24h")
-            if not price:
-                price = price_info.get("last_7d")
-                if not price:
-                    raise ValueError(
-                        f"CSGOTrader: Could not find steam price of the past 7 days: {url_decoded_name}"
-                    )
+            for timestamp in ("last_24h", "last_7d", "last_30d", "last_90d"):
+                price = price_info.get(timestamp)
+                if price:
+                    break
+            else:
+                raise ValueError(
+                    f"CSGOTrader: Could not find steam price info for the past 3 months: {url_decoded_name}"
+                )
         elif source == PriceSource.BUFF163:
             price = price_info.get("starting_at")
             if not price:
@@ -183,6 +170,18 @@ class CSGOTrader(Parser):
                 raise ValueError(
                     f"CSGOTrader: Could not find recent buff163 price: {url_decoded_name}"
                 )
+        elif source == PriceSource.YOUPIN898:
+            price = price_info
+            if not price:
+                raise ValueError(
+                    f"CSGOTrader: Could not find recent youpin898 price: {url_decoded_name}"
+                )
+        elif source == PriceSource.CSFLOAT:
+            price = price_info.get("price")
+            if not price:
+                raise ValueError(
+                    f"CSGOTrader: Could not find recent csfloat price: {url_decoded_name}"
+                )
         else:
             price = price_info.get("starting_at")
             if not price:
@@ -190,3 +189,7 @@ class CSGOTrader(Parser):
 
         price = float(price)
         return price
+
+
+# Default parser used by the scraper
+Parser = CSGOTraderParser