cs2tracker 2.1.13__tar.gz → 2.1.15__tar.gz

{cs2tracker-2.1.13 → cs2tracker-2.1.15}/.isort.cfg

@@ -1,2 +1,2 @@
 [settings]
-known_third_party = bs4,currency_converter,matplotlib,nodejs,requests,rich,sv_ttk,tenacity,tksheet,ttk_text,urllib3
+known_third_party = bs4,currency_converter,matplotlib,nodejs,requests,requests_cache,rich,sv_ttk,tenacity,tksheet,ttk_text,urllib3

cs2tracker-2.1.15/.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/asottile/seed-isort-config
+    rev: v2.2.0
+    hooks:
+      - id: seed-isort-config
+  - repo: https://github.com/ambv/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.3.0
+    hooks:
+      - id: flake8
+  - repo: https://github.com/timothycrosley/isort
+    rev: 6.0.1
+    hooks:
+      - id: isort
+        args: ["--profile=black"]
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.6
+    hooks:
+      - id: docformatter
+        additional_dependencies: [tomli]
+        args: [--in-place]

{cs2tracker-2.1.13 → cs2tracker-2.1.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cs2tracker
-Version: 2.1.13
+Version: 2.1.15
 Summary: Tracking the steam market prices of CS2 items
 Home-page: https://github.com/ashiven/cs2tracker
 Author: Jannik Novak
@@ -23,6 +23,7 @@ Requires-Dist: sv_ttk==2.6.1
 Requires-Dist: tksheet==7.5.12
 Requires-Dist: nodejs-bin==18.4.0a4
 Requires-Dist: ttk-text==0.2.0
+Requires-Dist: requests-cache==1.2.1
 Dynamic: license-file
 
 <p align="center">
@@ -40,9 +41,8 @@ Dynamic: license-file
 [![PyPI version](https://badge.fury.io/py/cs2tracker.svg)](https://badge.fury.io/py/cs2tracker)
 [![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/ashiven/cs2tracker)](https://github.com/ashiven/cs2tracker/issues)
 [![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr/ashiven/cs2tracker)](https://github.com/ashiven/cs2tracker/pulls)
-![GitHub Repo stars](https://img.shields.io/github/stars/ashiven/cs2tracker)
 
-<img src="https://github.com/user-attachments/assets/9585afb2-bf1a-473c-be5d-cccbb3349b9a"/>
+<img src="./assets/demo.gif"/>
 </div>
 
 ## Table of Contents
@@ -60,9 +60,9 @@ Dynamic: license-file
 ## Features
 
 - ⚡ Rapidly import your Storage Units
-- 🔍 Track CS2 Steam Market prices
+- 🔍 Track prices on Steam, Buff163, Youpin898
 - 📈 View investment price history
-- 🧾 Export/Import price data
+- 🧾 Export/Import history data
 - 📤 Discord notifications on updates
 - 📅 Daily background calculations
 - 🛡️ Proxy support to avoid rate limits
@@ -106,7 +106,7 @@ Dynamic: license-file
 ## Configuration
 
 You can configure the app settings via the **Edit Config** option.
-This will open the config editor where you can change any setting by simply double clicking on it. On top of that, the config editor allows you to:
+This will open the config editor where you can change any setting by double clicking on it or navigating to it with the arrow keys and hitting enter. On top of that, the config editor allows you to:
 
 - Automatically import items from your Storage Units
 - Manually Specify the number of items you own

{cs2tracker-2.1.13 → cs2tracker-2.1.15}/README.md

@@ -13,9 +13,8 @@
 [![PyPI version](https://badge.fury.io/py/cs2tracker.svg)](https://badge.fury.io/py/cs2tracker)
 [![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/ashiven/cs2tracker)](https://github.com/ashiven/cs2tracker/issues)
 [![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr/ashiven/cs2tracker)](https://github.com/ashiven/cs2tracker/pulls)
-![GitHub Repo stars](https://img.shields.io/github/stars/ashiven/cs2tracker)
 
-<img src="https://github.com/user-attachments/assets/9585afb2-bf1a-473c-be5d-cccbb3349b9a"/>
+<img src="./assets/demo.gif"/>
 </div>
 
 ## Table of Contents
@@ -33,9 +32,9 @@
 ## Features
 
 - ⚡ Rapidly import your Storage Units
-- 🔍 Track CS2 Steam Market prices
+- 🔍 Track prices on Steam, Buff163, Youpin898
 - 📈 View investment price history
-- 🧾 Export/Import price data
+- 🧾 Export/Import history data
 - 📤 Discord notifications on updates
 - 📅 Daily background calculations
 - 🛡️ Proxy support to avoid rate limits
@@ -79,7 +78,7 @@
 ## Configuration
 
 You can configure the app settings via the **Edit Config** option.
-This will open the config editor where you can change any setting by simply double clicking on it. On top of that, the config editor allows you to:
+This will open the config editor where you can change any setting by double clicking on it or navigating to it with the arrow keys and hitting enter. On top of that, the config editor allows you to:
 
 - Automatically import items from your Storage Units
 - Manually Specify the number of items you own

{cs2tracker-2.1.13 → cs2tracker-2.1.15}/cs2tracker/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.1.13'
-__version_tuple__ = version_tuple = (2, 1, 13)
+__version__ = version = '2.1.15'
+__version_tuple__ = version_tuple = (2, 1, 15)

cs2tracker-2.1.15/cs2tracker/app/app.py

@@ -0,0 +1,283 @@
+import ctypes
+import tkinter as tk
+from shutil import copy
+from tkinter import messagebox, ttk
+from tkinter.filedialog import askopenfilename, asksaveasfile
+
+import sv_ttk
+
+from cs2tracker.app.editor_frame import ConfigEditorFrame
+from cs2tracker.app.history_frame import PriceHistoryFrame
+from cs2tracker.app.scraper_frame import ScraperFrame
+from cs2tracker.config import get_config
+from cs2tracker.constants import ICON_FILE, OS, OUTPUT_FILE, OSType
+from cs2tracker.logs import PriceLogs
+from cs2tracker.scraper.background_task import BackgroundTask
+from cs2tracker.scraper.scraper import Scraper
+from cs2tracker.util.currency_conversion import CURRENCY_SYMBOLS
+from cs2tracker.util.tkinter import centered, fix_sv_ttk, size_info
+
+APPLICATION_NAME = "CS2Tracker"
+WINDOW_SIZE = "630x335"
+DARK_THEME = True
+
+SCRAPER_WINDOW_TITLE = "Price Overview"
+SCRAPER_WINDOW_SIZE = "900x750"
+
+CONFIG_EDITOR_TITLE = "Config Editor"
+CONFIG_EDITOR_SIZE = "850x750"
+
+PRICE_HISTORY_TITLE = "Price History"
+PRICE_HISTORY_SIZE = "900x700"
+
+config = get_config()
+
+
+class Application:
+    def __init__(self):
+        self.scraper = Scraper()
+
+    def run(self):
+        """Run the main application window."""
+        window = self._configure_window()
+
+        if DARK_THEME:
+            sv_ttk.use_dark_theme()
+        else:
+            sv_ttk.use_light_theme()
+
+        fix_sv_ttk(ttk.Style())
+
+        window.mainloop()
+
+    def _configure_window(self):
+        """Configure the main application window."""
+        window = tk.Tk()
+        window.title(APPLICATION_NAME)
+        window.geometry(centered(window, WINDOW_SIZE))
+        window.minsize(*size_info(WINDOW_SIZE))
+
+        if OS == OSType.WINDOWS:
+            app_id = "cs2tracker.unique.id"
+            ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(app_id)
+
+        icon = tk.PhotoImage(file=ICON_FILE)
+        window.wm_iconphoto(True, icon)
+
+        main_frame = MainFrame(window, self.scraper)
+        main_frame.pack(expand=True, fill="both")
+
+        return window
+
+
+class MainFrame(ttk.Frame):
+    # pylint: disable=too-many-instance-attributes,attribute-defined-outside-init
+    def __init__(self, parent, scraper):
+        super().__init__(parent, padding=15)
+        self.parent = parent
+        self.scraper = scraper
+        self._add_widgets()
+
+    def _add_widgets(self):
+        """Add widgets to the main frame."""
+        self.columnconfigure(0, weight=1)
+        self.columnconfigure(1, weight=1)
+        self.rowconfigure(0, weight=1)
+
+        self._configure_button_frame()
+        self.button_frame.grid(row=0, column=0, padx=10, pady=(0, 20), sticky="nsew")
+        self._configure_settings_frame()
+        self.settings_frame.grid(row=0, column=1, padx=10, pady=(0, 20), sticky="nsew")
+
+    def _add_button(self, text, command, row):
+        """Create and style a button for the button frame."""
+        grid_pos = {"row": row, "column": 0, "sticky": "ew", "padx": 10, "pady": 10}
+        button = ttk.Button(self.button_frame, text=text, command=command)
+        button.grid(**grid_pos)
+
+    def _configure_button_frame(self):
+        """Configure the button frame of the application main frame."""
+        self.button_frame = ttk.Frame(self, style="Card.TFrame", padding=15)
+        self.button_frame.columnconfigure(0, weight=1)
+
+        self._add_button("Run!", self.scrape_prices, 0)
+        self._add_button("Edit Config", self._edit_config, 1)
+        self._add_button("Show History", self._show_history, 2)
+        self._add_button("Export History", self._export_log_file, 3)
+        self._add_button("Import History", self._import_log_file, 4)
+
+    def _add_checkbox(
+        self, text, variable, command, row
+    ):  # pylint: disable=too-many-arguments,too-many-positional-arguments,attribute-defined-outside-init
+        """Create and style a checkbox for the checkbox frame."""
+        grid_pos = {"row": row, "column": 0, "sticky": "w", "padx": (10, 0), "pady": 5}
+        checkbox = ttk.Checkbutton(
+            self.settings_frame,
+            text=text,
+            variable=variable,
+            command=command,
+            style="Switch.TCheckbutton",
+        )
+        checkbox.grid(**grid_pos)
+
+    def _configure_settings_frame(self):
+        """Configure the settings frame for background tasks and other settings."""
+        self.settings_frame = ttk.LabelFrame(self, text="Settings", padding=15)
+        self.settings_frame.columnconfigure(0, weight=1)
+
+        self.background_checkbox_value = tk.BooleanVar(value=BackgroundTask.identify())
+        self._add_checkbox(
+            "Background Task",
+            self.background_checkbox_value,
+            lambda: self._toggle_background_task(self.background_checkbox_value.get()),
+            0,
+        )
+
+        self.discord_webhook_checkbox_value = tk.BooleanVar(value=config.discord_notifications)
+        self._add_checkbox(
+            "Discord Notifications",
+            self.discord_webhook_checkbox_value,
+            lambda: self.discord_webhook_checkbox_value.set(
+                self._toggle_discord_webhook(self.discord_webhook_checkbox_value.get())
+            ),
+            1,
+        )
+
+        self.use_proxy_checkbox_value = tk.BooleanVar(value=config.use_proxy)
+        self._add_checkbox(
+            "Proxy Requests",
+            self.use_proxy_checkbox_value,
+            lambda: self.use_proxy_checkbox_value.set(
+                self._toggle_use_proxy(self.use_proxy_checkbox_value.get())
+            ),
+            2,
+        )
+
+        self.dark_theme_checkbox_value = tk.BooleanVar(value=DARK_THEME)
+        self._add_checkbox("Dark Theme", self.dark_theme_checkbox_value, self._toggle_theme, 3)
+
+        self.currency_selection_label = ttk.Label(self.settings_frame, text="Currency:")
+        self.currency_selection_label.grid(row=4, column=0, sticky="w", padx=(20, 0), pady=5)
+        self.currency_selection = ttk.Combobox(
+            self.settings_frame,
+            state="readonly",
+            values=list(CURRENCY_SYMBOLS),
+            postcommand=self.parent.focus_set,
+        )
+        self.currency_selection.set(config.conversion_currency)
+        self.currency_selection.grid(row=5, column=0, sticky="w", padx=(20, 0), pady=5)
+
+        def on_currency_change(_):
+            config.set_app_option("conversion_currency", self.currency_selection.get())
+            self.currency_selection.selection_clear()
+            self.parent.focus_set()
+
+        self.currency_selection.bind(
+            "<<ComboboxSelected>>",
+            on_currency_change,
+        )
+
+    def scrape_prices(self):
+        """Scrape prices from the configured sources, print the total, and save the
+        results to a file.
+        """
+        scraper_window = tk.Toplevel(self.parent)
+        scraper_window.geometry(centered(scraper_window, SCRAPER_WINDOW_SIZE))
+        scraper_window.minsize(*size_info(SCRAPER_WINDOW_SIZE))
+        scraper_window.title(SCRAPER_WINDOW_TITLE)
+
+        run_frame = ScraperFrame(
+            scraper_window,
+            self.scraper,
+            sheet_size=SCRAPER_WINDOW_SIZE,
+            dark_theme=self.dark_theme_checkbox_value.get(),
+        )
+        run_frame.pack(expand=True, fill="both")
+        run_frame.start()
+
+    def _edit_config(self):
+        """Open a new window with a config editor GUI."""
+        config_editor_window = tk.Toplevel(self.parent)
+        config_editor_window.geometry(centered(config_editor_window, CONFIG_EDITOR_SIZE))
+        config_editor_window.minsize(*size_info(CONFIG_EDITOR_SIZE))
+        config_editor_window.title(CONFIG_EDITOR_TITLE)
+
+        editor_frame = ConfigEditorFrame(config_editor_window)
+        editor_frame.pack(expand=True, fill="both")
+
+    def _show_history(self):
+        """Show a chart consisting of past calculations."""
+        if PriceLogs.empty():
+            return
+
+        price_history_window = tk.Toplevel(self.parent)
+        price_history_window.geometry(centered(price_history_window, PRICE_HISTORY_SIZE))
+        price_history_window.minsize(*size_info(PRICE_HISTORY_SIZE))
+        price_history_window.title(PRICE_HISTORY_TITLE)
+
+        history_frame = PriceHistoryFrame(price_history_window)
+        history_frame.pack(expand=True, fill="both")
+
+    def _export_log_file(self):
+        """Lets the user export the log file to a different location."""
+        if PriceLogs.empty():
+            return
+
+        export_path = asksaveasfile(
+            title="Export Log File",
+            defaultextension=".csv",
+            filetypes=[("CSV File", "*.csv")],
+        )
+        if export_path:
+            copy(OUTPUT_FILE, export_path.name)
+
+    def _import_log_file(self):
+        """Lets the user import a log file from a different location."""
+        import_path = askopenfilename(
+            title="Import Log File",
+            defaultextension=".csv",
+            filetypes=[("CSV files", "*.csv")],
+        )
+        if not PriceLogs.validate_file(import_path):
+            return
+        copy(import_path, OUTPUT_FILE)
+
+    def _toggle_background_task(self, enabled: bool):
+        """Toggle whether a daily price calculation should run in the background."""
+        BackgroundTask.toggle(enabled)
+
+    def _toggle_use_proxy(self, enabled: bool):
+        """Toggle whether the scraper should use proxy servers for requests."""
+        proxy_api_key = config.proxy_api_key
+        if not proxy_api_key and enabled:
+            messagebox.showerror(
+                "Config Error",
+                "You need to enter a valid crawlbase API key into the configuration to use this feature.",
+                parent=self.parent,
+            )
+            return False
+
+        config.toggle_app_option("use_proxy", enabled)
+        return True
+
+    def _toggle_discord_webhook(self, enabled: bool):
+        """Toggle whether the scraper should send notifications to a Discord webhook."""
+        discord_webhook_url = config.discord_webhook_url
+        if not discord_webhook_url and enabled:
+            messagebox.showerror(
+                "Config Error",
+                "You need to enter a valid Discord webhook URL into the configuration to use this feature.",
+                parent=self.parent,
+            )
+            return False
+
+        config.toggle_app_option("discord_webhook", enabled)
+        return True
+
+    def _toggle_theme(self):
+        """Toggle the theme of the application."""
+        if self.dark_theme_checkbox_value.get():
+            sv_ttk.use_dark_theme()
+        else:
+            sv_ttk.use_light_theme()
+        fix_sv_ttk(ttk.Style())