cs2tracker 2.1.4__tar.gz → 2.1.6__tar.gz

{cs2tracker-2.1.4 → cs2tracker-2.1.6}/.gitignore

@@ -1,9 +1,10 @@
-output.csv
 .vscode
 __pycache__
 venv
 build
+output
 dist
 venv-test
 cs2tracker.egg-info
 _version.py
+cs2tracker_scraper.bat

{cs2tracker-2.1.4 → cs2tracker-2.1.6}/.pylintrc

@@ -4,7 +4,6 @@ disable=
     line-too-long,
     missing-module-docstring,
     missing-class-docstring,
-    too-few-public-methods,
     consider-using-with,
     import-error,
     no-else-return

{cs2tracker-2.1.4 → cs2tracker-2.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cs2tracker
-Version: 2.1.4
+Version: 2.1.6
 Summary: Tracking the steam market prices of CS2 items
 Home-page: https://github.com/ashiven/cs2tracker
 Author: Jannik Novak
@@ -40,29 +40,35 @@ Dynamic: license-file
 
 ### Prerequisites
 
--  Download and install the latest versions of [Python](https://www.python.org/downloads/) and [Pip](https://pypi.org/project/pip/).
--  Register for the [Crawlbase Smart Proxy API](https://crawlbase.com/) and retrieve your API key. (Optional)
+- Download and install the latest versions of [Python](https://www.python.org/downloads/) and [Pip](https://pypi.org/project/pip/). (Required for Linux)
+- Register for the [Crawlbase Smart Proxy API](https://crawlbase.com/) and retrieve your API key. (Optional)
 
 ### Setup
 
-1. Install the program via pip:
+#### Windows Executable *(no color support)*
+
+- Simply [download the latest executable](https://github.com/ashiven/cs2tracker/releases/latest/download/cs2tracker-windows.zip) and run it.
+
+#### Install via Pip
+
+1. Install the program:
 
    ```bash
-   pip install --user cs2tracker
+   pip install cs2tracker
    ```
 
-2. Start the program:
+2. Run it:
    ```bash
    cs2tracker
    ```
 
 ### Options
 
--  `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 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.
+- `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 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 in the config file. This will route every request through a different proxy server.
 
 ---
 

cs2tracker-2.1.6/README.md

@@ -0,0 +1,53 @@
+<div align="center">
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![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)
+
+</div>
+
+## About
+
+**CS2Tracker** is a tool that can be used to keep track of the steam market prices of your CS2 investment.
+
+## Getting Started
+
+### Prerequisites
+
+- Download and install the latest versions of [Python](https://www.python.org/downloads/) and [Pip](https://pypi.org/project/pip/). (Required for Linux)
+- Register for the [Crawlbase Smart Proxy API](https://crawlbase.com/) and retrieve your API key. (Optional)
+
+### Setup
+
+#### Windows Executable *(no color support)*
+
+- Simply [download the latest executable](https://github.com/ashiven/cs2tracker/releases/latest/download/cs2tracker-windows.zip) and run it.
+
+#### Install via Pip
+
+1. Install the program:
+
+   ```bash
+   pip install cs2tracker
+   ```
+
+2. Run it:
+   ```bash
+   cs2tracker
+   ```
+
+### Options
+
+- `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 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 in the config file. This will route every request through a different proxy server.
+
+---
+
+> GitHub [@ashiven](https://github.com/Ashiven) &nbsp;&middot;&nbsp;
+> Twitter [ashiven\_](https://twitter.com/ashiven_)

{cs2tracker-2.1.4 → cs2tracker-2.1.6}/cs2tracker/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.1.4'
-__version_tuple__ = version_tuple = (2, 1, 4)
+__version__ = version = '2.1.6'
+__version_tuple__ = version_tuple = (2, 1, 6)

cs2tracker-2.1.6/cs2tracker/application.py

@@ -0,0 +1,207 @@
+import tkinter as tk
+from subprocess import Popen
+from threading import Thread
+from typing import cast
+
+import matplotlib.pyplot as plt
+from matplotlib.axes import Axes
+from matplotlib.dates import DateFormatter
+
+from cs2tracker.constants import (
+    CONFIG_FILE,
+    OS,
+    OUTPUT_FILE,
+    PYTHON_EXECUTABLE,
+    RUNNING_IN_EXE,
+    TEXT_EDITOR,
+    OSType,
+)
+from cs2tracker.scraper import Scraper
+
+WINDOW_TITLE = "CS2Tracker"
+WINDOW_SIZE = "450x380"
+BACKGROUND_COLOR = "#1e1e1e"
+BUTTON_COLOR = "#3c3f41"
+BUTTON_HOVER_COLOR = "#505354"
+BUTTON_ACTIVE_COLOR = "#5c5f61"
+FONT_STYLE = "Segoe UI"
+FONT_COLOR = "white"
+
+SCRAPER_WINDOW_TITLE = "CS2Tracker"
+SCRAPER_WINDOW_HEIGHT = 40
+SCRAPER_WINDOW_WIDTH = 100
+SCRAPER_WINDOW_BACKGROUND_COLOR = "Black"
+
+
+class Application:
+    def __init__(self):
+        self.scraper = Scraper()
+
+    def run(self):
+        """Run the main application window with buttons for scraping prices, editing the
+        configuration, showing history in a chart, and editing the log file.
+        """
+        application_window = self._configure_window()
+        application_window.mainloop()
+
+    def _add_button(self, frame, text, command):
+        """Create and style a button for the main application window."""
+        button_style = {
+            "font": (FONT_STYLE, 12),
+            "fg": FONT_COLOR,
+            "bg": BUTTON_COLOR,
+            "activebackground": BUTTON_ACTIVE_COLOR,
+        }
+        button = tk.Button(frame, text=text, command=command, **button_style)
+        button.pack(pady=5, fill="x")
+        button.bind("<Enter>", lambda _: button.config(bg=BUTTON_HOVER_COLOR))
+        button.bind("<Leave>", lambda _: button.config(bg=BUTTON_COLOR))
+        return button
+
+    def _configure_window(self):
+        """Configure the main application window UI and add buttons for the main
+        functionalities.
+        """
+        window = tk.Tk()
+        window.title(WINDOW_TITLE)
+        window.geometry(WINDOW_SIZE)
+        window.configure(bg=BACKGROUND_COLOR)
+
+        frame = tk.Frame(window, bg=BACKGROUND_COLOR, padx=30, pady=30)
+        frame.pack(expand=True, fill="both")
+
+        label = tk.Label(
+            frame,
+            text=f"Welcome to {WINDOW_TITLE}!",
+            font=(FONT_STYLE, 16, "bold"),
+            fg=FONT_COLOR,
+            bg=BACKGROUND_COLOR,
+        )
+        label.pack(pady=(0, 30))
+
+        self._add_button(frame, "Run!", self.scrape_prices)
+        self._add_button(frame, "Edit Config", self._edit_config)
+        self._add_button(frame, "Show History (Chart)", self._draw_plot)
+        self._add_button(frame, "Show History (File)", self._edit_log_file)
+
+        background_checkbox_value = tk.BooleanVar(value=self.scraper.identify_background_task())
+        background_checkbox = tk.Checkbutton(
+            frame,
+            text="Daily Background Calculation",
+            variable=background_checkbox_value,
+            command=lambda: self._toggle_background_task(background_checkbox_value.get()),
+            bg=BACKGROUND_COLOR,
+            fg=FONT_COLOR,
+            selectcolor=BUTTON_COLOR,
+            activebackground=BACKGROUND_COLOR,
+            font=(FONT_STYLE, 10),
+        )
+        background_checkbox.pack(pady=20)
+
+        return window
+
+    def _construct_scraper_command_windows(self):
+        """Construct the command to run the scraper in a new window for Windows."""
+        set_utf8_encoding = (
+            "[Console]::InputEncoding = [Console]::OutputEncoding = [System.Text.Encoding]::UTF8;"
+        )
+        get_size = "$size = $Host.UI.RawUI.WindowSize;"
+        set_size = "$Host.UI.RawUI.WindowSize = $size;"
+        set_window_title = f"$Host.UI.RawUI.WindowTitle = '{SCRAPER_WINDOW_TITLE}';"
+        set_window_width = (
+            f"$size.Width = [Math]::Min({SCRAPER_WINDOW_WIDTH}, $Host.UI.RawUI.BufferSize.Width);"
+        )
+        set_window_height = f"$size.Height = {SCRAPER_WINDOW_HEIGHT};"
+        set_background_color = (
+            f"$Host.UI.RawUI.BackgroundColor = '{SCRAPER_WINDOW_BACKGROUND_COLOR}';"
+        )
+        clear = "Clear-Host;"
+
+        if RUNNING_IN_EXE:
+            # The python executable is set as the executable itself in PyInstaller
+            scraper_cmd = f"{PYTHON_EXECUTABLE} --only-scrape | Out-Host -Paging"
+        else:
+            scraper_cmd = f"{PYTHON_EXECUTABLE} -m cs2tracker --only-scrape"
+
+        cmd = (
+            'start powershell -NoExit -Command "& {'
+            + set_utf8_encoding
+            + set_window_title
+            + get_size
+            + set_window_width
+            + set_window_height
+            + set_size
+            + set_background_color
+            + clear
+            + scraper_cmd
+            + '}"'
+        )
+        return cmd
+
+    def _construct_scraper_command(self):
+        """Construct the command to run the scraper in a new window."""
+        if OS == OSType.WINDOWS:
+            return self._construct_scraper_command_windows()
+        else:
+            # TODO: Implement for Linux
+            return ""
+
+    def scrape_prices(self):
+        """Scrape prices from the configured sources, print the total, and save the
+        results to a file.
+        """
+        if OS == OSType.WINDOWS:
+            scraper_cmd = self._construct_scraper_command()
+            Popen(scraper_cmd, shell=True)
+        else:
+            # TODO: implement external window for Linux
+            self.scraper.scrape_prices()
+
+    def _edit_config(self):
+        """Edit the configuration file using the specified text editor."""
+        _popen_and_call(
+            popen_args={"args": [TEXT_EDITOR, CONFIG_FILE], "shell": True},
+            callback=self.scraper.parse_config,
+        )
+
+    def _draw_plot(self):
+        """Draw a plot of the scraped prices over time."""
+        dates, dollars, euros = self.scraper.read_price_log()
+
+        fig, ax_raw = plt.subplots(figsize=(10, 8), num="CS2Tracker Price History")
+        fig.suptitle("CS2Tracker Price History", fontsize=16)
+        fig.autofmt_xdate()
+
+        ax = cast(Axes, ax_raw)
+        ax.plot(dates, dollars, label="Dollars")
+        ax.plot(dates, euros, label="Euros")
+        ax.legend()
+        date_formatter = DateFormatter("%d-%m-%Y")
+        ax.xaxis.set_major_formatter(date_formatter)
+
+        plt.show()
+
+    def _edit_log_file(self):
+        """Opens the file containing past price calculations."""
+        Popen([TEXT_EDITOR, OUTPUT_FILE], shell=True)
+
+    def _toggle_background_task(self, enabled: bool):
+        """Toggle whether a daily price calculation should run in the background."""
+        self.scraper.toggle_background_task(enabled)
+
+
+def _popen_and_call(popen_args, callback):
+    """
+    Runs the given args in a subprocess.Popen, and then calls the function callback when
+    the subprocess completes.
+
+    Source: https://stackoverflow.com/questions/2581817/python-subprocess-callback-when-cmd-exits
+    """
+
+    def process_and_callback(popen_args, callback):
+        process = Popen(**popen_args)
+        process.wait()
+        callback()
+
+    thread = Thread(target=process_and_callback, args=(popen_args, callback), daemon=True)
+    thread.start()