small restructure

offish · offish · commit 7c19a79013a5 · 2025-03-01T14:02:15.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -172,6 +172,3 @@ cython_debug/
 
 # PyPI configuration file
 .pypirc
-
-# Other
-_build
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2024 offish
+Copyright (c) 2019-2025 offish
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.rst b/README.rst
@@ -4,13 +4,14 @@ tf2-utils
 
 ``tf2-utils`` is a collection of tools and utilities for TF2 trading. 
 Use 3rd party inventory providers, SKUs formatting, interact with various APIs, websockets and more.
-``tf2-utils`` is built on top of `tf2-sku <https://github.com/offish/tf2-sku>`_ and `tf2-data <https://github.com/offish/tf2-data>`_.
+``tf2-utils`` is built on top of `tf2-sku <https://github.com/offish/tf2-sku>`_, `tf2-data <https://github.com/offish/tf2-data>`_ 
+and `backpack-tf <https://github.com/offish/backpack-tf>`_.
 ``tf2-utils`` is a key dependency of `tf2-express <https://github.com/offish/tf2-express>`_.
 
 Donate
 ------
 
-- BTC: ``bc1qntlxs7v76j0zpgkwm62f6z0spsvyezhcmsp0z2``
+- BTC: ``bc1q9gmh5x2g9s0pw3282a5ypr6ms8qvuxh3fd7afh``
 - `Steam Trade Offer <https://steamcommunity.com/tradeoffer/new/?partner=293059984&token=0-l_idZR>`_
 
 You can reach me at `Steam <https://steamcommunity.com/id/confern>`_, 
@@ -54,9 +55,9 @@ Updating
 
 .. code-block:: bash
 
-    pip install --upgrade tf2-utils tf2-sku tf2-data
+    pip install --upgrade tf2-utils tf2-sku tf2-data bptf
     # or 
-    python -m pip install --upgrade tf2-utils tf2-sku tf2-data
+    python -m pip install --upgrade tf2-utils tf2-sku tf2-data bptf
 
 
 Development
@@ -67,7 +68,7 @@ Testing
 .. code-block:: bash
 
     # tf2-utils/
-    python -m unittest
+    pytest
 
 Documentation
 ~~~~~~~~~~~~~
@@ -85,7 +86,7 @@ License
 -------
 MIT License
 
-Copyright (c) 2019-2024 offish (`confern <https://steamcommunity.com/id/confern>`_)
+Copyright (c) 2019-2025 offish (`confern <https://steamcommunity.com/id/confern>`_)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/conftest.py b/conftest.py
@@ -1,11 +1,19 @@
+from os import getenv
+
 import pytest
+from dotenv import load_dotenv
+
+assert load_dotenv()
+
+MARKETPLACE_TF_API_KEY = getenv("MARKETPLACE_TF_API_KEY")
+BACKPACK_TF_TOKEN = getenv("BACKPACK_TF_TOKEN")
 
 
 @pytest.fixture
 def marketplace_tf_api_key() -> str:
-    return "api_key"
+    return MARKETPLACE_TF_API_KEY
 
 
 @pytest.fixture
 def backpack_tf_token() -> str:
-    return "backpack_tf_token"
+    return BACKPACK_TF_TOKEN
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,9 +13,9 @@ Table of Contents
    pages/marketplace_tf
    pages/offer
    pages/prices_tf
+   pages/prices_tf_websocket
    pages/schema
    pages/sku
-   pages/sockets
    pages/utils
 
 
diff --git a/docs/pages/prices_tf_websocket.rst b/docs/pages/prices_tf_websocket.rst
@@ -7,6 +7,6 @@ PricesTF Example
 .. literalinclude:: ../usage/prices_tf_socket.py
     :language: python3
 
-.. automodule:: src.tf2_utils.sockets
+.. automodule:: src.tf2_utils.prices_tf_websocket
     :members:
     :undoc-members:
diff --git a/example.env b/example.env
@@ -0,0 +1,2 @@
+MARKETPLACE_TF_API_KEY=apikey
+BACKPACK_TF_TOKEN=token
diff --git a/pyproject.toml b/pyproject.toml
@@ -16,7 +16,7 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
 ]
-dependencies = ["tf2-sku", "tf2-data", "backpack-tf", "requests", "websocket-client"]
+dependencies = ["tf2-sku", "tf2-data", "bptf", "requests", "websocket-client"]
 dynamic = ["version"]
 
 [project.urls]
diff --git a/src/tf2_utils/__init__.py b/src/tf2_utils/__init__.py
@@ -4,13 +4,14 @@
 __version__ = "2.3.0"
 __license__ = "MIT"
 
-from .sku import *
+from .currency import CurrencyExchange
+from .exceptions import *
+from .inventory import Inventory, map_inventory
 from .item import Item
+from .marketplace_tf import *
 from .offer import Offer
-from .utils import *
+from .prices_tf import PricesTF
+from .prices_tf_websocket import PricesTFWebsocket
 from .schema import SchemaItemsUtils
-from .sockets import PricesTFWebsocket
-from .prices_tf import *
-from .inventory import Inventory, map_inventory
-from .currency import CurrencyExchange
-from .marketplace_tf import *
+from .sku import *
+from .utils import *
diff --git a/src/tf2_utils/currency.py b/src/tf2_utils/currency.py
@@ -33,21 +33,17 @@ def __init__(
         self.our_combination = []  # list of metal names
 
     def get_pure_value(self, name: str) -> int:
-        match name:
-            # refined
-            case "Mann Co. Supply Crate Key":
-                return self.key_price
+        if name == "Mann Co. Supply Crate Key":
+            return self.key_price
 
-            case "Refined Metal":
-                return 9
+        if name == "Refined Metal":
+            return 9
 
-            # reclaimed
-            case "Reclaimed Metal":
-                return 3
+        if name == "Reclaimed Metal":
+            return 3
 
-            # scrap
-            case "Scrap Metal":
-                return 1
+        if name == "Scrap Metal":
+            return 1
 
         raise ValueError(f"{name} is not pure")
 
diff --git a/src/tf2_utils/exceptions.py b/src/tf2_utils/exceptions.py
@@ -0,0 +1,37 @@
+# generic
+class TF2UtilsError(Exception):
+    pass
+
+
+class InvalidInventory(TF2UtilsError):
+    pass
+
+
+# pricestf
+class PricesTFError(TF2UtilsError):
+    pass
+
+
+class InternalServerError(PricesTFError):
+    pass
+
+
+class RateLimited(PricesTFError):
+    pass
+
+
+class EmptyResponse(PricesTFError):
+    pass
+
+
+# marketplacetf
+class MarketplaceTFException(TF2UtilsError):
+    pass
+
+
+class SKUDoesNotMatch(MarketplaceTFException):
+    pass
+
+
+class NoAPIKey(MarketplaceTFException):
+    pass
diff --git a/src/tf2_utils/inventory.py b/src/tf2_utils/inventory.py
@@ -1,5 +1,6 @@
 import requests
 
+from .exceptions import InvalidInventory
 from .providers.custom import Custom
 from .providers.steamapis import SteamApis
 from .providers.steamcommunity import SteamCommunity
@@ -12,6 +13,9 @@ def map_inventory(inventory: dict, add_skus: bool = False) -> list[dict]:
     adds `sku` to each item entry if `add_skus` is enabled"""
     mapped_inventory = []
 
+    if "assets" not in inventory:
+        raise InvalidInventory("No assets found in inventory")
+
     for asset in inventory["assets"]:
         for desc in inventory["descriptions"]:
             if (
diff --git a/src/tf2_utils/marketplace_tf.py b/src/tf2_utils/marketplace_tf.py
@@ -2,27 +2,14 @@
 
 import requests
 
+from .exceptions import NoAPIKey, SKUDoesNotMatch
 from .schema import SchemaItemsUtils
 from .sku import sku_is_craftable, sku_to_quality_name
 
-__all__ = ["MarketplaceTF", "MarketplaceTFException", "SKUDoesNotMatch", "NoAPIKey"]
-
-
-class MarketplaceTFException(Exception):
-    pass
-
-
-class SKUDoesNotMatch(MarketplaceTFException):
-    pass
-
-
-class NoAPIKey(MarketplaceTFException):
-    pass
-
 
 def api_key_required(func):
     def wrapper(self, *args, **kwargs):
-        if self.api_key == "":
+        if self._api_key is None:
             raise NoAPIKey("No API key provided")
 
         return func(self, *args, **kwargs)
@@ -31,18 +18,20 @@ def wrapper(self, *args, **kwargs):
 
 
 class MarketplaceTF:
-    def __init__(self, api_key: str = ""):
-        self.api_key = api_key
-        self.schema = SchemaItemsUtils()
-        self.data = {}
+    def __init__(self, api_key: str = None):
+        self._api_key = api_key
+        self._schema = SchemaItemsUtils()
+        self._data = {}
 
-    def _get_request(self, endpoint: str, params: dict = {}):
+    def _get_request(self, endpoint: str, params: dict = {}) -> dict:
         url = "https://marketplace.tf/api" + endpoint
 
-        if self.api_key:
-            params["key"] = self.api_key
+        if self._api_key is not None:
+            params["key"] = self._api_key
 
         response = requests.get(url, params=params)
+        response.raise_for_status()
+
         return response.json()
 
     def get_endpoints(self) -> dict:
@@ -73,9 +62,9 @@ def get_dashboard_items(self) -> dict:
         return self._get_request("/Seller/GetDashboardItems/v2")
 
     @api_key_required
-    def get_sales(self, number: int = 100, start_before: float = 0.0) -> dict:
-        if start_before == 0.0:
-            start_before = time.time()
+    def get_sales(self, number: int = 100, start_before: int = 0) -> dict:
+        if start_before == 0:
+            start_before = int(time.time())
 
         return self._get_request(
             "/Seller/GetSales/v2", {"num": number, "start_before": start_before}
@@ -89,23 +78,26 @@ def _format_url(item_name: str, quality: str, craftable: bool) -> str:
         return f"{url}/{quality}/{item_name}/Tradable/{craftable}"
 
     def _format_url_sku(self, sku: str) -> str:
-        item_name = self.schema.sku_to_base_name(sku)
+        item_name = self._schema.sku_to_base_name(sku)
         quality = sku_to_quality_name(sku)
 
         return self._format_url(item_name, quality, sku_is_craftable(sku))
 
     @staticmethod
-    def _format_price_to_float(price: str) -> float:
+    def _format_price_to_float(price: str | float) -> float:
+        if isinstance(price, float):
+            return price
+
         return float(price.replace("$", ""))
 
     def _set_data(self, data: dict) -> None:
-        self.data = data["prices"]["mp"]
+        self._data = data["prices"]["mp"]
 
     def fetch_item_raw(self, item_name: str, quality: str, craftable: bool) -> dict:
         url = self._format_url(item_name, quality, craftable)
         self._set_data(requests.get(url).json())
 
-        return self.data
+        return self._data
 
     def fetch_item(self, sku: str) -> dict:
         url = self._format_url_sku(sku)
@@ -115,60 +107,44 @@ def fetch_item(self, sku: str) -> dict:
         if mptf_sku != sku:
             raise SKUDoesNotMatch(f"SKU {sku} does not match {mptf_sku}")
 
-        return self.data
+        return self._data
 
     def get_item_data(self) -> dict:
-        return self.data
+        return self._data
 
     def get_lowest_price(self) -> float:
-        price = self.data.get("lowest_price")
-
-        if price is None:
-            return 0.0
-
+        price = self._data.get("lowest_price", 0.0)
         return self._format_price_to_float(price)
 
     def get_price(self) -> float:
         return self.get_lowest_price()
 
     def get_highest_buy_order(self) -> float:
-        price = self.data.get("highest_buy_order")
-
-        if price is None:
-            return 0.0
-
+        price = self._data.get("highest_buy_order", 0.0)
         return self._format_price_to_float(price)
 
     def get_buy_order(self) -> float:
         return self.get_highest_buy_order()
 
     def get_stock(self) -> int:
-        return self.data.get("num_for_sale", 0)
+        return self._data.get("num_for_sale", 0)
 
     def get_sku(self) -> str:
-        return self.data.get("sku", "")
+        return self._data.get("sku", "")
 
     def fetch_lowest_price(self, sku: str) -> float:
-        price = self.fetch_item_data(sku).get("lowest_price")
-
-        if price is None:
-            return 0.0
-
+        price = self.fetch_item(sku).get("lowest_price", 0.0)
         return self._format_price_to_float(price)
 
     def fetch_price(self, sku: str) -> float:
         return self.fetch_lowest_price(sku)
 
     def fetch_highest_buy_order(self, sku: str) -> float:
-        price = self.fetch_item_data(sku).get("highest_buy_order")
-
-        if price is None:
-            return 0.0
-
+        price = self.fetch_item(sku).get("highest_buy_order")
         return self._format_price_to_float(price)
 
     def fetch_buy_order(self, sku: str) -> float:
         return self.fetch_highest_buy_order(sku)
 
     def fetch_stock(self, sku: str) -> int:
-        return self.fetch_item_data(sku).get("num_for_sale", 0)
+        return self.fetch_item(sku).get("num_for_sale", 0)
diff --git a/src/tf2_utils/prices_tf.py b/src/tf2_utils/prices_tf.py
diff --git a/src/tf2_utils/prices_tf_websocket.py b/src/tf2_utils/prices_tf_websocket.py
diff --git a/src/tf2_utils/schema.py b/src/tf2_utils/schema.py
diff --git a/src/tf2_utils/sku.py b/src/tf2_utils/sku.py
diff --git a/tests/test_inventory.py b/tests/test_inventory.py
diff --git a/tests/test_marketplace_tf.py b/tests/test_marketplace_tf.py

-Original file line number
+Diff line change
 # PyPI configuration file
 .pypirc
+-
 -# Other
 -_build
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+MARKETPLACE_TF_API_KEY=apikey`
	`2`	`+BACKPACK_TF_TOKEN=token`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ classifiers = [`
`16`	`16`	`"License :: OSI Approved :: MIT License",`
`17`	`17`	`"Operating System :: OS Independent",`
`18`	`18`	`]`
`19`		`-dependencies = ["tf2-sku", "tf2-data", "backpack-tf", "requests", "websocket-client"]`
	`19`	`+dependencies = ["tf2-sku", "tf2-data", "bptf", "requests", "websocket-client"]`
`20`	`20`	`dynamic = ["version"]`
`21`	`21`
`22`	`22`	`[project.urls]`