rewrite (#4)

Author: offish

.github/workflows/publish.yml

@@ -0,0 +1,17 @@
+name: Upload Python Package
+on:
+  release:
+    types: [published]
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - run: python3 -m pip install --upgrade build && python3 -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -0,0 +1,4 @@
+.vscode
+__pycache__
+/*.json
+jsons

README.md

@@ -1,5 +1,95 @@
-# tf2-utils
-
-``` 
-pip install tf2utils
-``` 
+# tf2-utils
+[![License](https://img.shields.io/github/license/offish/tf2-utils.svg)](https://github.com/offish/tf2-utils/blob/master/LICENSE)
+[![Stars](https://img.shields.io/github/stars/offish/tf2-utils.svg)](https://github.com/offish/tf2-utils/stargazers)
+[![Issues](https://img.shields.io/github/issues/offish/tf2-utils.svg)](https://github.com/offish/tf2-utils/issues)
+[![Size](https://img.shields.io/github/repo-size/offish/tf2-utils.svg)](https://github.com/offish/tf2-utils)
+[![Discord](https://img.shields.io/discord/467040686982692865?color=7289da&label=Discord&logo=discord)](https://discord.gg/t8nHSvA)
+[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Tools and utilities for TF2 trading. Use 3rd party inventory providers, get SKUs directly from inventories, listen to BackpackTF's websocket and more.
+
+## Donate
+- BTC: `bc1qntlxs7v76j0zpgkwm62f6z0spsvyezhcmsp0z2`
+- [Steam Trade Offer](https://steamcommunity.com/tradeoffer/new/?partner=293059984&token=0-l_idZR)
+
+## Usage
+
+### Inventory fetching
+```python
+from tf2_utils import Inventory
+
+# using 3rd party provider to avoid being rate-limited
+provider = Inventory("steamsupply", "9st947vs0qmgfpeqde1gj92l0oqmhysm")
+
+# using steam as inventory provider
+provider = Inventory() # or Inventory("steamcommunity")
+
+# get an inventory
+inventory = provider.fetch("76561198253325712")
+```
+
+### Gettings SKUs from inventories
+**NOTE: NOT ALL SKU ATTRIBUTES ARE ADDED YET**
+#### Get SKUs implicitly
+```python
+from tf2_utils import Inventory, map_inventory
+
+provider = Inventory("steamcommunity")
+
+user_inventory = provider.fetch("76561198253325712")
+inventory = map_inventory(user_inventory, add_skus=True)
+```
+
+#### Get a particular item's SKU
+```python
+from tf2_utils import get_sku
+
+inventory = map_inventory(user_inventory)
+
+for item in inventory:
+    sku = get_sku(item)
+```
+
+### BackpackTF Websocket
+#### Handle one listing at a time
+```python
+from tf2_utils import BackpackTFWebsocket
+
+def my_function(data: dict):
+    print("got data!", data)
+
+socket = BackpackTFWebsocket(my_function)
+
+socket.listen()
+```
+
+#### Handle list of listings at a time
+```python
+from tf2_utils import BackpackTFWebsocket
+
+def my_function(data: list[dict]):
+    print("got listings")
+
+    for listing in data:
+        print("listing", listing)
+
+socket = BackpackTFWebsocket(my_function, solo_entries=False)
+
+socket.listen()
+```
+
+## Setup
+### Install
+```bash
+pip install tf2-utils
+# or 
+python -m pip install tf2-utils
+```
+
+### Upgrade
+```bash
+pip upgrade tf2-utils
+# or 
+python -m pip upgrade tf2-utils
+```
+

pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tf2-utils"
+authors = [
+  { name="offish", email="overutilization@gmail.com" },
+]
+description = "Tools and utilities for TF2 trading"
+readme = "README.md"
+requires-python = ">=3.7"
+keywords = ["tf2", "utils", "sku"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = ["tf2-sku", "requests", "websocket-client"]
+dynamic = ["version"]
+
+[project.urls]
+"Homepage" = "https://github.com/offish/tf2-utils"
+"Bug Tracker" = "https://github.com/offish/tf2-utils/issues"
+
+[tool.setuptools_scm]

setup.py

@@ -1,22 +1,3 @@
-import setuptools
+from setuptools import setup
 
-with open("README.md", "r") as fh:
-    long_description = fh.read()
-
-setuptools.setup(
-    name="tf2utils",
-    version="1.0.0",
-    author="offish",
-    author_email="overutilization@gmail.com",
-    description="Easily interact with multiple APIs associated with Team Fortress 2",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/offish/tf2utils",
-    packages=setuptools.find_packages(),
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-    ],
-    python_requires='>=3.7',
-)
+setup()

src/tf2_utils/__init__.py

@@ -0,0 +1,10 @@
+__title__ = "tf2-utils"
+__author__ = "offish"
+__version__ = "1.0.0"
+__license__ = "MIT"
+
+from .schema import Schema, IEconItems
+from .inventory import Inventory, map_inventory
+from .sku import get_sku, get_sku_properties
+from .utils import to_refined, to_scrap, refinedify
+from .backpack_tf import BackpackTFWebsocket

src/tf2_utils/backpack_tf.py

@@ -0,0 +1,54 @@
+import json
+
+from websockets.sync.client import connect
+
+
+class BackpackTFWebsocket:
+    URL = "wss://ws.backpack.tf/events"
+
+    def __init__(
+        self,
+        callback,
+        solo_entries: bool = True,
+        headers: dict = {"batch-test": True},
+        max_size: int | None = None,
+        settings: dict = {},
+    ) -> None:
+        """
+        :param callback: Function pointer where you want the data to end up
+
+        :param solo_entries: If data to callback should be solo entries or a batched list
+        :type solo_entries: bool
+        :param headers: Additional headers to send to the socket
+        :type headers: dict
+        :param settings: Additional websocket settings as a dict to be unpacked
+        :type settings: dict
+        """
+        self.callback = callback
+        self.solo_entries = solo_entries
+        self.headers = headers
+        self.max_size = max_size
+        self.settings = settings
+
+    def process_messages(self, data: str) -> None:
+        messages = json.loads(data)
+
+        if not self.solo_entries:
+            self.callback(messages)
+            return
+
+        for message in messages:
+            payload = message["payload"]
+            self.callback(payload)
+
+    def listen(self) -> None:
+        """Listen for messages from BackpackTF"""
+        with connect(
+            self.URL,
+            additional_headers=self.headers,
+            max_size=self.max_size,
+            **self.settings,
+        ) as websocket:
+            while True:
+                data = websocket.recv()
+                self.process_messages(data)

src/tf2_utils/inventory.py

@@ -0,0 +1,64 @@
+from .providers.steamcommunity import SteamCommunity
+from .providers.steamsupply import SteamSupply
+from .providers.steamapis import SteamApis
+from .sku import get_sku
+
+import requests
+
+
+def map_inventory(inventory: dict, add_skus: bool = False) -> list[dict]:
+    """Matches classids and instanceids, merges these and
+    adds `sku` to each item entry if `add_skus` is enabled"""
+    mapped_inventory = []
+
+    for asset in inventory["assets"]:
+        for desc in inventory["descriptions"]:
+            if (
+                desc["tradable"] != 1
+                or asset["classid"] != desc["classid"]
+                or asset["instanceid"] != desc["instanceid"]
+            ):
+                continue
+
+            # ok, match
+            if add_skus:
+                mapped_inventory.append({"sku": get_sku(desc), **asset, **desc})
+            else:
+                mapped_inventory.append({**asset, **desc})
+            break
+
+    return mapped_inventory
+
+
+class Inventory:
+    PROVIDERS = [SteamSupply, SteamApis]
+
+    def __init__(
+        self, provider_name: str = "steamcommunity", api_key: str = ""
+    ) -> None:
+        # set default provider for intellisense
+        self.provider = SteamCommunity()
+
+        # default to steam if no api_key is given
+        if not api_key:
+            return
+
+        if provider_name == "steamcommunity":
+            # already set
+            return
+
+        # loop through providers create object
+        for i in self.PROVIDERS:
+            if provider_name.lower() == i.__name__.lower():
+                # set the first found provider and then stop
+                self.provider = i(api_key)
+                break
+
+    def fetch(self, steam_id: str, app_id: int = 440, context_id: int = 2) -> dict:
+        url, params = self.provider.get_url_and_params(steam_id, app_id, context_id)
+        response = requests.get(url, params=params)
+
+        try:
+            return response.json()
+        except:
+            return {}