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

cs2tracker/util/validated_config.py

@@ -1,25 +1,45 @@
+import json
 import re
-from configparser import ConfigParser
-
-from cs2tracker.constants import CAPSULE_INFO, CONFIG_FILE
-from cs2tracker.util.padded_console import PaddedConsole
-
-console = PaddedConsole()
+from configparser import ConfigParser, ParsingError
+from urllib.parse import quote, unquote
 
+from cs2tracker.constants import CAPSULE_PAGES, CONFIG_FILE, INVENTORY_IMPORT_FILE
+from cs2tracker.util.padded_console import get_console
 
+STEAM_MARKET_LISTING_BASEURL_CS2 = "https://steamcommunity.com/market/listings/730/"
 STEAM_MARKET_LISTING_REGEX = r"^https://steamcommunity.com/market/listings/\d+/.+$"
 
+console = get_console()
+
 
 class ValidatedConfig(ConfigParser):
     def __init__(self):
         """Initialize the ValidatedConfig class."""
         super().__init__(delimiters=("~"), interpolation=None)
         self.optionxform = str  # type: ignore
-        super().read(CONFIG_FILE)
 
         self.valid = False
         self.last_error = None
-        self._validate_config()
+        try:
+            self.load_from_file()
+        except (FileNotFoundError, ParsingError) as error:
+            console.error(f"Config error: {error}")
+            self.last_error = error
+
+    def delete_display_sections(self):
+        """
+        Delete all sections that are displayed to the user from the config.
+
+        (This excludes the internal App Settings section)
+        """
+        use_proxy = self.getboolean("App Settings", "use_proxy", fallback=False)
+        discord_notifications = self.getboolean(
+            "App Settings", "discord_notifications", fallback=False
+        )
+        self.clear()
+        self.add_section("App Settings")
+        self.set("App Settings", "use_proxy", str(use_proxy))
+        self.set("App Settings", "discord_notifications", str(discord_notifications))
 
     def _validate_config_sections(self):
         """Validate that the configuration file has all required sections."""
@@ -31,7 +51,7 @@ class ValidatedConfig(ConfigParser):
             raise ValueError("Missing 'Custom Items' section in the configuration file.")
         if not self.has_section("Cases"):
             raise ValueError("Missing 'Cases' section in the configuration file.")
-        for capsule_section in CAPSULE_INFO:
+        for capsule_section in CAPSULE_PAGES:
             if not self.has_section(capsule_section):
                 raise ValueError(f"Missing '{capsule_section}' section in the configuration file.")
 
@@ -48,16 +68,21 @@ class ValidatedConfig(ConfigParser):
                     raise ValueError(
                         f"Invalid value in 'Custom Items' section: {custom_item_href} = {custom_item_owned}"
                     )
-            for case_name, case_owned in self.items("Cases"):
+            for case_href, case_owned in self.items("Cases"):
+                if not re.match(STEAM_MARKET_LISTING_REGEX, case_href):
+                    raise ValueError(
+                        f"Invalid Steam market listing URL in 'Cases' section: {case_href}"
+                    )
+
                 if int(case_owned) < 0:
                     raise ValueError(
-                        f"Invalid value in 'Cases' section: {case_name} = {case_owned}"
+                        f"Invalid value in 'Cases' section: {case_href} = {case_owned}"
                     )
-            for capsule_section in CAPSULE_INFO:
-                for capsule_name, capsule_owned in self.items(capsule_section):
+            for capsule_section in CAPSULE_PAGES:
+                for capsule_href, capsule_owned in self.items(capsule_section):
                     if int(capsule_owned) < 0:
                         raise ValueError(
-                            f"Invalid value in '{capsule_section}' section: {capsule_name} = {capsule_owned}"
+                            f"Invalid value in '{capsule_section}' section: {capsule_href} = {capsule_owned}"
                         )
         except ValueError as error:
             if "Invalid " in str(error):
@@ -77,18 +102,86 @@ class ValidatedConfig(ConfigParser):
             self._validate_config_values()
             self.valid = True
         except ValueError as error:
-            console.print(f"[bold red][!] Config error: {error}")
+            console.error(f"Config error: {error}")
             self.valid = False
             self.last_error = error
 
+    def load_from_file(self):
+        """Load the configuration file and validate it."""
+        self.clear()
+        self.read(CONFIG_FILE)
+        self._validate_config()
+
     def write_to_file(self):
-        """Write the current configuration to the configuration file."""
+        """Validate the current configuration and write it to the configuration file if
+        it is valid.
+        """
         self._validate_config()
 
         if self.valid:
             with open(CONFIG_FILE, "w", encoding="utf-8") as config_file:
                 self.write(config_file)
 
+    def read_from_inventory_file(self):
+        """
+        Read an inventory file into the configuration.
+
+        This file is generated after a user automatically imports their inventory.
+        """
+        try:
+            with open(INVENTORY_IMPORT_FILE, "r", encoding="utf-8") as inventory_file:
+                inventory_data = json.load(inventory_file)
+                added_to_config = set()
+
+                for item_name, item_owned in inventory_data.items():
+                    option_name_href = self.name_to_option(item_name, href=True)
+                    for section in self.sections():
+                        if option_name_href in self.options(section):
+                            self.set(section, option_name_href, str(item_owned))
+                            added_to_config.add(item_name)
+
+                for item_name, item_owned in inventory_data.items():
+                    if item_name not in added_to_config:
+                        url_encoded_item_name = quote(item_name)
+                        listing_url = f"{STEAM_MARKET_LISTING_BASEURL_CS2}{url_encoded_item_name}"
+                        self.set("Custom Items", listing_url, str(item_owned))
+
+            self.write_to_file()
+        except (FileNotFoundError, json.JSONDecodeError) as error:
+            console.error(f"Error reading inventory file: {error}")
+            self.last_error = error
+            self.valid = False
+
+    def option_to_name(self, option, href=False):
+        """
+        Convert an internal option representation to a reader-friendly name.
+
+        :param option: The internal option representation to convert.
+        :param custom: If True, the option is for a custom item.
+        :return: The reader-friendly name.
+        """
+        if href:
+            converted_option = unquote(option.split("/")[-1])
+        else:
+            converted_option = option.replace("_", " ").title()
+
+        return converted_option
+
+    def name_to_option(self, name, href=False):
+        """
+        Convert a reader-friendly name to an internal option representation.
+
+        :param name: The reader-friendly name to convert.
+        :param custom: If True, the name is for a custom item.
+        :return: The internal option representation.
+        """
+        if href:
+            converted_name = STEAM_MARKET_LISTING_BASEURL_CS2 + quote(name)
+        else:
+            converted_name = name.replace(" ", "_").lower()
+
+        return converted_name
+
     def toggle_use_proxy(self, enabled: bool):
         """
         Toggle the use of proxies for requests. This will update the configuration file.
@@ -115,3 +208,11 @@ class ValidatedConfig(ConfigParser):
         console.print(
             f"[bold green]{'[+] Enabled' if enabled else '[-] Disabled'} Discord webhook notifications."
         )
+
+
+config = ValidatedConfig()
+
+
+def get_config():
+    """Accessor function to retrieve the current configuration."""
+    return config

cs2tracker-2.1.14.dist-info/METADATA

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: cs2tracker
+Version: 2.1.14
+Summary: Tracking the steam market prices of CS2 items
+Home-page: https://github.com/ashiven/cs2tracker
+Author: Jannik Novak
+Author-email: nevisha@pm.me
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy==1.26.4
+Requires-Dist: beautifulsoup4==4.11.1
+Requires-Dist: CurrencyConverter==0.17.9
+Requires-Dist: matplotlib==3.7.0
+Requires-Dist: Requests==2.31.0
+Requires-Dist: rich==13.6.0
+Requires-Dist: tenacity==8.2.2
+Requires-Dist: urllib3==2.1.0
+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">
+  <h2 align="center">CS2Tracker</h2>
+</p>
+
+<p align="center">
+  A simple, elegant GUI tool to track CS2 item investments
+</p>
+
+<div align="center">
+
+[![CC BY-NC-ND 4.0][cc-by-nc-nd-shield]][cc-by-nc-nd]
+[![GitHub Release](https://img.shields.io/github/v/release/ashiven/cs2tracker)](https://github.com/ashiven/cs2tracker/releases)
+[![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"/>
+</div>
+
+## Table of Contents
+
+- [Features](#features)
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+- [Usage](#usage)
+- [Configuration](#configuration)
+- [Advanced Features](#advanced-features)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+
+- ⚡ Rapidly import your Storage Units
+- 🔍 Track CS2 Steam Market prices
+- 📈 View investment price history
+- 🧾 Export/Import price data
+- 📤 Discord notifications on updates
+- 📅 Daily background calculations
+- 🛡️ Proxy support to avoid rate limits
+
+## Getting Started
+
+### Prerequisites
+
+- Download and install the latest versions of [Python](https://www.python.org/downloads/) and [Pip](https://pypi.org/project/pip/). (Required on Linux)
+- Register for the [Crawlbase Smart Proxy API](https://crawlbase.com/) and retrieve your API key. (Optional)
+- Create a [Discord Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to be notified about recent price updates. (Optional)
+
+### Installation
+
+#### Option 1: Windows Executable
+
+- Simply [download the latest executable](https://github.com/ashiven/cs2tracker/releases/latest/download/cs2tracker-windows.zip) and run it.
+
+#### Option 2: Install via Pip
+
+1. Install the program:
+
+   ```bash
+   pip install cs2tracker
+   ```
+
+2. Run it:
+
+   ```bash
+   cs2tracker
+   ```
+
+## Usage
+
+- Click **Run!** to gather the current market prices of your items and calculate the total amount in USD and EUR.
+- The generated Excel sheet can be saved by right-clicking and then selecting **Save Sheet**.
+- Use **Edit Config** to specify the numbers of items owned in the configuration.
+- Click **Show History** to see a price chart consisting of past calculations.
+- Use **Export / Import History** to export or import the price history to or from a CSV 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 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
+- Add custom items that are not listed in the config
+- Enter Discord webhook and Crawlbase proxy API keys
+
+## Advanced Features
+
+- Enable **Daily Background Calculations** to automatically run a daily calculation of your investment in the background.
+- Use **Receive Discord Notifications** to receive a notification on your Discord server whenever the program has finished calculating your investment.
+- You need to set up a [webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) in your Discord server and enter the webhook url into the `discord_webhook_url` field in the config `User Settings`.
+- Enable **Proxy Requests** to prevent your requests from being rate limited by the steamcommunity server.
+- You need to register for a free API key on [Crawlbase](crawlbase.com) and enter it into the `proxy_api_key` field in the config `User Settings`.
+
+## Contributing
+
+Please feel free to submit a pull request or open an issue. See [issues](https://github.com/ashiven/cs2tracker/issues) and [pull requests](https://github.com/ashiven/cs2tracker/pulls) for current work.
+
+1. Fork the repository
+2. Create a new branch
+3. Make your changes
+4. Submit a PR
+
+## License
+
+This project is licensed under the
+[Creative Commons Attribution-NonCommercial-NoDerivs 4.0 International License][cc-by-nc-nd].
+
+[![CC BY-NC-ND 4.0][cc-by-nc-nd-image]][cc-by-nc-nd]
+
+[cc-by-nc-nd]: http://creativecommons.org/licenses/by-nc-nd/4.0/
+[cc-by-nc-nd-image]: https://licensebuttons.net/l/by-nc-nd/4.0/88x31.png
+[cc-by-nc-nd-shield]: https://img.shields.io/badge/License-CC%20BY--NC--ND%204.0-lightgrey.svg
+
+---
+
+> GitHub [@ashiven](https://github.com/Ashiven) &nbsp;&middot;&nbsp;
+> Twitter [ashiven\_](https://twitter.com/ashiven_)

cs2tracker-2.1.14.dist-info/RECORD

@@ -0,0 +1,28 @@
+cs2tracker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cs2tracker/__main__.py,sha256=Ub--oSMv48YzfWF1CZqYlkn1-HvZ7Bhxoc7urn1oY6o,249
+cs2tracker/_version.py,sha256=80wtCyj9QUrrEVvuEW7o-ILwCKz10sXaQFnSq4DOKBE,513
+cs2tracker/constants.py,sha256=9E1CPVEohDmV_F2PLLrPRmtYAHHVDimbUFfohhjci1c,6742
+cs2tracker/main.py,sha256=_Y8be0bVDaoO4SE-TZjJ0wpXjvXDYF3VPKC4f32nZc0,1019
+cs2tracker/app/__init__.py,sha256=uqAxdDzoR2-2IrDc1riIU3Pi9vLEDwr68eg93-0RFmM,105
+cs2tracker/app/application.py,sha256=wjUFt5RzRZ8gRqprtPaCTtHW_cEWS3DzmcdRz48vmFg,9135
+cs2tracker/app/editor_frame.py,sha256=zbNaZOBhFCWjJrl-kCgdbBPafeRgEcYG31tDgMaZ3_s,21313
+cs2tracker/app/scraper_frame.py,sha256=9m5tQFhPGCqWWtkgSG_XuH9ELj-km83lU93tSBqndNA,4007
+cs2tracker/data/config.ini,sha256=oLm6Ggfqjr8coDZE4NAMVomZZDJqMia0VxNO3wCzHsQ,15059
+cs2tracker/data/convert_inventory.js,sha256=5bEDfe9Rf2wYC4dIlmvjhbslfnuKuBBNjuTk67jEV9Q,5370
+cs2tracker/data/get_inventory.js,sha256=YL0RJV1j2K0J20mRZVXSakwU8fpRtjyMLrAYFl0-rsM,5793
+cs2tracker/data/output.csv,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cs2tracker/scraper/__init__.py,sha256=kfUB9yfshSche92ZvTqQQYBkVqujRez46djPoa9u0YU,335
+cs2tracker/scraper/background_task.py,sha256=1_lKnFWn9wuABpru58JdQbfDHjL0Up-7h6Nlcc4TsZ4,3671
+cs2tracker/scraper/discord_notifier.py,sha256=-PdTRAtzMHTjDH17zguI0LKB7INITEohx0da0fWRdKI,2962
+cs2tracker/scraper/parsers.py,sha256=BcCRU39RXtkpXOZouh2LLTDlCOJAFAJmyaQVVwK1i4A,6897
+cs2tracker/scraper/scraper.py,sha256=sotDjZMrMxkM_bCOhPm9S-Pq82-pJp-8RPNcxtY9cPs,10462
+cs2tracker/util/__init__.py,sha256=Pgltyrkotd5ijU-srmY5vaFP7gzz9itSAl2LfS-D7-E,322
+cs2tracker/util/padded_console.py,sha256=u8SNbjvR_YyePhpiqREt4Kh4NiDI5NAPCPL5toqh8dg,1622
+cs2tracker/util/price_logs.py,sha256=JuZ2ptDtxA-NzKjpG_4q0eeOr1IaUvVah-Qth6GrDDU,4165
+cs2tracker/util/validated_config.py,sha256=ZsUTaahs08HBEoCM2XUzAHqjKeaeU3XzBNhGxr1kEfg,8740
+cs2tracker-2.1.14.dist-info/licenses/LICENSE,sha256=doPNswWMPXbkhplb9cnZLwJoqqS72pJPhkSib8kIF08,19122
+cs2tracker-2.1.14.dist-info/METADATA,sha256=hehgmIANx4SmR2lJOlurlsV54ERx9TVg3fi80No46kM,5782
+cs2tracker-2.1.14.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cs2tracker-2.1.14.dist-info/entry_points.txt,sha256=K8IwDIkg8QztSB9g9c89B9jR_2pG4QyJGrNs4z5RcZw,63
+cs2tracker-2.1.14.dist-info/top_level.txt,sha256=2HB4xDDOxaU5BDc_yvdi9UlYLgL768n8aR-hRhFM6VQ,11
+cs2tracker-2.1.14.dist-info/RECORD,,