cs2tracker 2.1.2__py3-none-any.whl → 2.1.3__py3-none-any.whl

cs2tracker/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.1.2'
-__version_tuple__ = version_tuple = (2, 1, 2)
+__version__ = version = '2.1.3'
+__version_tuple__ = version_tuple = (2, 1, 3)

cs2tracker/application.py

@@ -28,31 +28,43 @@ class Application:
         """
         window = tk.Tk()
         window.title("CS2Tracker")
-        window.geometry("400x400")
+        window.geometry("450x450")
 
         label = tk.Label(window, text="Welcome to CS2Tracker!")
-        label.grid(column=0, row=0, pady=50, sticky="NSEW")
-
         run_button = tk.Button(window, text="Run!", command=self._scrape_prices)
         edit_button = tk.Button(window, text="Edit Config", command=self._edit_config)
         plot_button = tk.Button(window, text="Show History (Chart)", command=self._draw_plot)
-        plotfile_button = tk.Button(window, text="Show History (File)", command=self._edit_log_file)
-
+        plot_file_button = tk.Button(
+            window, text="Show History (File)", command=self._edit_log_file
+        )
+        background_checkbox_value = tk.BooleanVar(value=self.scraper.identify_background_task())
+        background_checkbox = tk.Checkbutton(
+            window,
+            text="Daily Background Calculation",
+            command=lambda: self._toggle_background_task(background_checkbox_value.get()),
+            variable=background_checkbox_value,
+        )
+
+        label.grid(row=0, column=0, pady=50, sticky="NSEW")
         run_button.grid(row=1, column=0, pady=10, sticky="NSEW")
         edit_button.grid(row=2, column=0, pady=10, sticky="NSEW")
         plot_button.grid(row=3, column=0, pady=10, sticky="NSEW")
-        plotfile_button.grid(row=4, column=0, pady=10, sticky="NSEW")
+        plot_file_button.grid(row=4, column=0, pady=10, sticky="NSEW")
+        background_checkbox.grid(row=5, column=0, pady=10, sticky="NS")
 
         window.grid_columnconfigure(0, weight=1)
         window.grid_rowconfigure(1, weight=1)
         window.grid_rowconfigure(2, weight=1)
         window.grid_rowconfigure(3, weight=1)
         window.grid_rowconfigure(4, weight=1)
+        window.grid_rowconfigure(5, weight=1)
+
         label.grid_configure(sticky="NSEW")
         run_button.grid_configure(sticky="NSEW")
         edit_button.grid_configure(sticky="NSEW")
         plot_button.grid_configure(sticky="NSEW")
-        plotfile_button.grid_configure(sticky="NSEW")
+        plot_file_button.grid_configure(sticky="NSEW")
+        background_checkbox.grid_configure(sticky="NSEW")
 
         return window
 
@@ -80,8 +92,8 @@ class Application:
         ax.set_ylabel("Price")
         ax.legend()
 
-        date_form = DateFormatter("%d-%m-%Y")
-        ax.xaxis.set_major_formatter(date_form)
+        date_formatter = DateFormatter("%d-%m-%Y")
+        ax.xaxis.set_major_formatter(date_formatter)
         fig.autofmt_xdate()
 
         plt.show()
@@ -91,3 +103,7 @@ class Application:
         if not os.path.isfile(OUTPUT_FILE):
             open(OUTPUT_FILE, "w", encoding="utf-8").close()
         subprocess.call([TEXT_EDITOR, OUTPUT_FILE])
+
+    def _toggle_background_task(self, enabled: bool):
+        """Toggle whether a daily price calculation should run in the background."""
+        self.scraper.toggle_background_task(enabled)

cs2tracker/constants.py

@@ -1,10 +1,13 @@
 import os
 import sys
 
-TEXT_EDITOR = "notepad" if sys.platform == "win32" else "nano"
-BASE_DIR = os.path.dirname(os.path.abspath(__file__)).replace("\\", "/")
-OUTPUT_FILE = f"{BASE_DIR}/data/output.csv"
-CONFIG_FILE = f"{BASE_DIR}/data/config.ini"
+TEXT_EDITOR = "notepad" if sys.platform.startswith("win") else "nano"
+PYTHON_EXECUTABLE = sys.executable
+MODULE_DIR = os.path.dirname(os.path.abspath(__file__))
+PROJECT_DIR = os.path.dirname(MODULE_DIR)
+OUTPUT_FILE = os.path.join(MODULE_DIR, "data", "output.csv")
+CONFIG_FILE = os.path.join(MODULE_DIR, "data", "config.ini")
+BATCH_FILE = os.path.join(MODULE_DIR, "data", "cs2tracker_scraper.bat")
 
 
 RMR_CAPSULES = {
@@ -145,7 +148,6 @@ SHANGHAI_CAPSULES = {
     ],
 }
 
-
 AUSTIN_CAPSULES = {
     "page": "https://steamcommunity.com/market/search?q=austin+capsule",
     "items": [

cs2tracker/data/config.ini

@@ -1,3 +1,7 @@
+[Settings]
+Use_Proxy = False
+API_Key = None
+
 [2020 RMR Sticker Capsule]
 RMR_Challengers = 0
 RMR_Legends = 0
@@ -107,7 +111,3 @@ Winter_Offensive_Case = 0
 Kilowatt_Case = 0
 Gallery_Case = 0
 Fever_Case = 0
-
-[Settings]
-Use_Proxy = False
-API_Key = None

cs2tracker/main.py

@@ -15,7 +15,7 @@ def main():
     application.
     """
 
-    ## disable warnings for proxy requests
+    # Disable warnings for proxy requests
     urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
     console = Console()

cs2tracker/scraper.py

@@ -1,8 +1,10 @@
 import csv
 import os
+import sys
 import time
 from configparser import ConfigParser
 from datetime import datetime
+from subprocess import DEVNULL, call
 
 from bs4 import BeautifulSoup
 from bs4.element import Tag
@@ -13,16 +15,21 @@ from rich.console import Console
 from tenacity import RetryError, retry, stop_after_attempt
 
 from cs2tracker.constants import (
+    BATCH_FILE,
     CAPSULE_INFO,
     CASE_HREFS,
     CASE_PAGES,
     CONFIG_FILE,
     OUTPUT_FILE,
+    PROJECT_DIR,
+    PYTHON_EXECUTABLE,
 )
 
 MAX_LINE_LEN = 72
 SEPARATOR = "-"
 PRICE_INFO = "Owned: {}      Steam market price: ${}      Total: ${}\n"
+BACKGROUND_TASK_NAME = "CS2Tracker Daily Calculation"
+BACKGROUND_TASK_TIME = "12:00"
 
 
 class Scraper:
@@ -61,7 +68,7 @@ class Scraper:
             capsule_usd_total = self.scrape_capsule_section_prices()
         except (RequestException, AttributeError, RetryError, ValueError):
             self.console.print(
-                "[bold red]Failed to scrape capsule prices. (Consider using proxies to prevent rate limiting)\n"
+                "[bold red][!] Failed to scrape capsule prices. (Consider using proxies to prevent rate limiting)\n"
             )
 
         case_usd_total = 0
@@ -69,7 +76,7 @@ class Scraper:
             case_usd_total = self._scrape_case_prices()
         except (RequestException, AttributeError, RetryError, ValueError):
             self.console.print(
-                "[bold red]Failed to scrape case prices. (Consider using proxies to prevent rate limiting)\n"
+                "[bold red][!] Failed to scrape case prices. (Consider using proxies to prevent rate limiting)\n"
             )
 
         self.usd_total += capsule_usd_total
@@ -79,7 +86,7 @@ class Scraper:
         self._print_total()
         self._save_price_log()
 
-        # reset totals for next run
+        # Reset totals for next run
         self.usd_total, self.eur_total = 0, 0
 
     def _print_total(self):
@@ -109,13 +116,9 @@ class Scraper:
 
         with open(OUTPUT_FILE, "r", encoding="utf-8") as price_logs:
             price_logs_reader = csv.reader(price_logs)
-            last_row = None
+            last_log_date = ""
             for row in price_logs_reader:
-                last_row = row
-            if last_row:
-                last_log_date = last_row[0][:10]
-            else:
-                last_log_date = ""
+                last_log_date, _ = row
 
         today = datetime.now().strftime("%Y-%m-%d")
         if last_log_date != today:
@@ -135,7 +138,7 @@ class Scraper:
             open(OUTPUT_FILE, "w", encoding="utf-8").close()
 
         dates, dollars, euros = [], [], []
-        with open(OUTPUT_FILE, "r", newline="", encoding="utf-8") as price_logs:
+        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, price_with_currency = row
@@ -217,18 +220,15 @@ class Scraper:
         console.
 
         :param capsule_section: The section name in the config for the capsule.
-        :param capsule_info: A dictionary containing information about the capsule
-            section,
+        :param capsule_info: A dictionary containing information about the capsule page,
+            hrefs, and names.
         """
         capsule_title = capsule_section.center(MAX_LINE_LEN, SEPARATOR)
         self.console.print(f"[bold magenta]{capsule_title}")
 
-        capsule_price_total = 0
-        capsule_page = capsule_info["page"]
-        capsule_names = capsule_info["names"]
-        capsule_hrefs = capsule_info["items"]
-        capsule_page = self._get_page(capsule_page)
-        for capsule_name, capsule_href in zip(capsule_names, capsule_hrefs):
+        capsule_usd_total = 0
+        capsule_page = self._get_page(capsule_info["page"])
+        for capsule_name, capsule_href in zip(capsule_info["names"], capsule_info["items"]):
             config_capsule_name = capsule_name.replace(" ", "_")
             owned = self.config.getint(capsule_section, config_capsule_name, fallback=0)
             if owned == 0:
@@ -239,15 +239,15 @@ class Scraper:
 
             self.console.print(f"[bold deep_sky_blue4]{capsule_name}")
             self.console.print(PRICE_INFO.format(owned, price_usd, price_usd_owned))
-            capsule_price_total += price_usd_owned
+            capsule_usd_total += price_usd_owned
 
-        return capsule_price_total
+        return capsule_usd_total
 
     def scrape_capsule_section_prices(self):
         """Scrape prices for all capsule sections defined in the configuration."""
         capsule_usd_total = 0
         for capsule_section, capsule_info in CAPSULE_INFO.items():
-            # only scrape capsule sections where the user owns at least one item
+            # Only scrape capsule sections where the user owns at least one item
             if any(int(owned) > 0 for _, owned in self.config.items(capsule_section)):
                 capsule_usd_total += self._scrape_capsule_prices(capsule_section, capsule_info)
 
@@ -283,7 +283,7 @@ class Scraper:
         For each case, it prints the case name, owned count, price per item, and total
         price for owned items.
         """
-        case_price_total = 0
+        case_usd_total = 0
         for case_index, (config_case_name, owned) in enumerate(self.config.items("Cases")):
             if int(owned) == 0:
                 continue
@@ -297,9 +297,93 @@ class Scraper:
             price_usd_owned = round(float(int(owned) * price_usd), 2)
 
             self.console.print(PRICE_INFO.format(owned, price_usd, price_usd_owned))
-            case_price_total += price_usd_owned
+            case_usd_total += price_usd_owned
 
             if not self.config.getboolean("Settings", "Use_Proxy", fallback=False):
                 time.sleep(1)
 
-        return case_price_total
+        return case_usd_total
+
+    def identify_background_task(self):
+        """
+        Search the OS for a daily background task that runs the scraper.
+
+        :return: True if a background task is found, False otherwise.
+        """
+        if sys.platform.startswith("win"):
+            cmd = ["schtasks", "/query", "/tn", BACKGROUND_TASK_NAME]
+            return_code = call(cmd, stdout=DEVNULL, stderr=DEVNULL)
+            found = return_code == 0
+            return found
+        else:
+            # TODO: implement finder for cron jobs
+            return False
+
+    def _toggle_task_batch_file(self, enabled: bool):
+        """
+        Create or delete a batch file that runs the scraper.
+
+        :param enabled: If True, the batch file will be created; if False, the batch
+            file will be deleted.
+        """
+        if enabled:
+            with open(BATCH_FILE, "w", encoding="utf-8") as batch_file:
+                batch_file.write(f"cd {PROJECT_DIR}\n")
+                batch_file.write(f"{PYTHON_EXECUTABLE} -m cs2tracker.scraper\n")
+        else:
+            if os.path.exists(BATCH_FILE):
+                os.remove(BATCH_FILE)
+
+    def _toggle_background_task_windows(self, enabled: bool):
+        """
+        Create or delete a daily background task that runs the scraper on Windows.
+
+        :param enabled: If True, the task will be created; if False, the task will be
+            deleted.
+        """
+        self._toggle_task_batch_file(enabled)
+        if enabled:
+            cmd = [
+                "schtasks",
+                "/create",
+                "/tn",
+                BACKGROUND_TASK_NAME,
+                "/tr",
+                BATCH_FILE,
+                "/sc",
+                "DAILY",
+                "/st",
+                BACKGROUND_TASK_TIME,
+            ]
+            return_code = call(cmd, stdout=DEVNULL, stderr=DEVNULL)
+            if return_code == 0:
+                self.console.print("[bold green][+] Background task enabled.")
+            else:
+                self.console.print("[bold red][!] Failed to enable background task.")
+        else:
+            cmd = ["schtasks", "/delete", "/tn", BACKGROUND_TASK_NAME, "/f"]
+            return_code = call(cmd, stdout=DEVNULL, stderr=DEVNULL)
+            if return_code == 0:
+                self.console.print("[bold green][-] Background task disabled.")
+            else:
+                self.console.print("[bold red][!] Failed to disable background task.")
+
+    def toggle_background_task(self, enabled: bool):
+        """
+        Create or delete a daily background task that runs the scraper.
+
+        :param enabled: If True, the task will be created; if False, the task will be
+            deleted.
+        """
+        if sys.platform.startswith("win"):
+            self._toggle_background_task_windows(enabled)
+        else:
+            # TODO: implement toggle for cron jobs
+            pass
+
+
+if __name__ == "__main__":
+    # If this file is run as a script, create a Scraper instance and run the
+    # scrape_prices method.
+    scraper = Scraper()
+    scraper.scrape_prices()

{cs2tracker-2.1.2.dist-info → cs2tracker-2.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cs2tracker
-Version: 2.1.2
+Version: 2.1.3
 Summary: Tracking the steam market prices of CS2 items
 Home-page: https://github.com/ashiven/cs2tracker
 Author: Jannik Novak
@@ -60,7 +60,8 @@ Dynamic: license-file
 
 -  `Run!` to gather the current market prices of your items and calculate the total amount in USD and EUR.
 -  `Edit Config` to change the specific numbers of each item you own and then save the config file.
--  `Show History` to see a price chart consisting of past calculations. A new data point for this chart is generated once a day upon running the program.
+-  `Show History` to see a price chart consisting of past calculations. A new data point is generated once a day upon running the program.
+-  `Daily Background Calculation` to automatically run a daily calculation of your investment in the background and save the results such that they can later be viewed via `Show History`.
 -  If you want to prevent your requests from being rate limited by the steamcommunity server, register for an API key on [Crawlbase](crawlbase.com) and enter it into the `API_Key` field at the end of the config file. This will route every request through a different proxy server.
 
 ---

cs2tracker-2.1.3.dist-info/RECORD

@@ -0,0 +1,14 @@
+cs2tracker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cs2tracker/__main__.py,sha256=Ub--oSMv48YzfWF1CZqYlkn1-HvZ7Bhxoc7urn1oY6o,249
+cs2tracker/_version.py,sha256=BiGPztNyl3M8e5PrbQdJPlg8lFWgerKsXwbz544Fc2s,511
+cs2tracker/application.py,sha256=CYuvEV2PlAKQ0MD_9vLViTonzspQFWJBGN6rzAOpAQY,4212
+cs2tracker/constants.py,sha256=VG4QBedqHT9kjehWU-Uop7MNlD1VuERgL_VA4oN3obc,15127
+cs2tracker/main.py,sha256=YmWXza0lmDDvLbOWzkJ6n0B1c-tq7Ub-IpwXSeIoKuQ,1309
+cs2tracker/scraper.py,sha256=PjcGga-_odlcFBrh5poNYcgAwRQferXU7HLpf67W8L8,15229
+cs2tracker/data/config.ini,sha256=LbdwEMFlgD8ubuEvGhYZdPtYsWhlho3nX3SLWi4T7Kg,2637
+cs2tracker-2.1.3.dist-info/licenses/LICENSE.md,sha256=G5wqQ_8KGA808kVuF-Fpu_Yhteg8K_5ux9n2v8eQK7s,1069
+cs2tracker-2.1.3.dist-info/METADATA,sha256=jW4vLzcuQamN64985L4bFfAXNcidLOSNY84ncgoBNs8,2954
+cs2tracker-2.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cs2tracker-2.1.3.dist-info/entry_points.txt,sha256=K8IwDIkg8QztSB9g9c89B9jR_2pG4QyJGrNs4z5RcZw,63
+cs2tracker-2.1.3.dist-info/top_level.txt,sha256=2HB4xDDOxaU5BDc_yvdi9UlYLgL768n8aR-hRhFM6VQ,11
+cs2tracker-2.1.3.dist-info/RECORD,,

cs2tracker-2.1.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-cs2tracker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cs2tracker/__main__.py,sha256=Ub--oSMv48YzfWF1CZqYlkn1-HvZ7Bhxoc7urn1oY6o,249
-cs2tracker/_version.py,sha256=R_mUEqlkeWeuDiw8DRbHmYUvRxDtmQQJqhTpV8pds-Y,511
-cs2tracker/application.py,sha256=8nPUPcPOnatg98_XfSpWjD06-V0jDoy7CT_DNSGuszk,3431
-cs2tracker/constants.py,sha256=8jqaMM9eKEmqNTGWQ_h9EiSqYTIEPOAhe5l1zg2ycko,14953
-cs2tracker/main.py,sha256=T4X-oLYfltnu0ALBTIJagZTLFmWMhxZrfD1pfFLAUpg,1310
-cs2tracker/scraper.py,sha256=XiRjYSLkBd_DFjJ-1951D_3iIaL5jDMMRWCqgWGBMJ0,12201
-cs2tracker/data/config.ini,sha256=zieID1dhlEAquPCXbpmvsnvxJAnrDqHSNrS6AIj1F-Q,2637
-cs2tracker-2.1.2.dist-info/licenses/LICENSE.md,sha256=G5wqQ_8KGA808kVuF-Fpu_Yhteg8K_5ux9n2v8eQK7s,1069
-cs2tracker-2.1.2.dist-info/METADATA,sha256=bS8LgXrOUv0_t84kiUfU6Vybyoq3U8Q4tIqeeKJMMrs,2781
-cs2tracker-2.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cs2tracker-2.1.2.dist-info/entry_points.txt,sha256=K8IwDIkg8QztSB9g9c89B9jR_2pG4QyJGrNs4z5RcZw,63
-cs2tracker-2.1.2.dist-info/top_level.txt,sha256=2HB4xDDOxaU5BDc_yvdi9UlYLgL768n8aR-hRhFM6VQ,11
-cs2tracker-2.1.2.dist-info/RECORD,,