tf2-sku-to-name 1.0.6__tar.gz → 2.0.0__tar.gz

tf2_sku_to_name-2.0.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: tf2-sku-to-name
+Version: 2.0.0
+Summary: A python library that parses TF2 item SKU to the item's name and vice versa.
+Home-page: https://github.com/purplebarber/tf2-sku
+Author: Purple Barber
+License: MIT
+Keywords: tf2,tf2-sku,team fortress 2,sku,parser
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# tf2-sku
+
+A Python library for parsing Team Fortress 2 item SKUs to item names and vice versa.
+
+## Features
+- Convert SKUs to item names
+- Convert item names to SKUs
+
+## Installation
+
+```bash
+pip install tf2-sku-to-name
+```
+
+## Quick Start
+
+```python
+from sku import Sku
+
+# Convert SKU to name
+sku = "5021;6"
+name = Sku.sku_to_name(sku)
+print(name)  # Output: Mann Co. Supply Crate Key
+
+# Convert name to SKU
+name = "Burning Flames Team Captain"
+sku = Sku.name_to_sku(name)
+print(sku)  # Output: 378;5;u13
+
+# Working with item objects
+from sku import itemClass
+
+item = itemClass()
+item.Defindex = 424
+item.Quality = 11
+item.Killstreak = 3
+
+sku = Sku.object_to_sku(item)
+print(sku)  # Output: 424;11;kt-3
+```
+
+## Advanced Usage
+
+### Schema Management
+
+The library automatically manages TF2 schema data:
+
+```python
+from sku import get_schema, update_schema
+
+# Get the current schema instance
+schema = get_schema()
+
+# Access schema data
+item = schema.get_item_by_defindex(5021)
+print(item['item_name'])  # Mann Co. Supply Crate Key
+
+# Force update schema (by default uses autobot.tf)
+update_schema()
+
+# Or use Steam API (requires API key)
+update_schema(api_key="YOUR_STEAM_API_KEY", use_autobot=False)
+```
+
+## Installation
+```bash
+pip install tf2-sku-to-name
+```
+
+## Acknowledgements
+[TF2Autobot's node-tf2-schema](https://github.com/TF2Autobot/node-tf2-schema) for the original JavaScript implementation\
+[idinium96's tf2autobot](https://github.com/TF2Autobot/tf2autobot) for the item name schema\
+Inspired by [Nicklason's node-tf2-sku](https://github.com/Nicklason/node-tf2-sku) and [TryHardDo's TF2Sku](https://github.com/TryHardDo/TF2Sku/tree/master)

tf2_sku_to_name-2.0.0/README.md

@@ -0,0 +1,73 @@
+# tf2-sku
+
+A Python library for parsing Team Fortress 2 item SKUs to item names and vice versa.
+
+## Features
+- Convert SKUs to item names
+- Convert item names to SKUs
+
+## Installation
+
+```bash
+pip install tf2-sku-to-name
+```
+
+## Quick Start
+
+```python
+from sku import Sku
+
+# Convert SKU to name
+sku = "5021;6"
+name = Sku.sku_to_name(sku)
+print(name)  # Output: Mann Co. Supply Crate Key
+
+# Convert name to SKU
+name = "Burning Flames Team Captain"
+sku = Sku.name_to_sku(name)
+print(sku)  # Output: 378;5;u13
+
+# Working with item objects
+from sku import itemClass
+
+item = itemClass()
+item.Defindex = 424
+item.Quality = 11
+item.Killstreak = 3
+
+sku = Sku.object_to_sku(item)
+print(sku)  # Output: 424;11;kt-3
+```
+
+## Advanced Usage
+
+### Schema Management
+
+The library automatically manages TF2 schema data:
+
+```python
+from sku import get_schema, update_schema
+
+# Get the current schema instance
+schema = get_schema()
+
+# Access schema data
+item = schema.get_item_by_defindex(5021)
+print(item['item_name'])  # Mann Co. Supply Crate Key
+
+# Force update schema (by default uses autobot.tf)
+update_schema()
+
+# Or use Steam API (requires API key)
+update_schema(api_key="YOUR_STEAM_API_KEY", use_autobot=False)
+```
+
+## Installation
+```bash
+pip install tf2-sku-to-name
+```
+
+## Acknowledgements
+[TF2Autobot's node-tf2-schema](https://github.com/TF2Autobot/node-tf2-schema) for the original JavaScript implementation\
+[idinium96's tf2autobot](https://github.com/TF2Autobot/tf2autobot) for the item name schema\
+Inspired by [Nicklason's node-tf2-sku](https://github.com/Nicklason/node-tf2-sku) and [TryHardDo's TF2Sku](https://github.com/TryHardDo/TF2Sku/tree/master)

tf2_sku_to_name-2.0.0/setup.py

@@ -0,0 +1,29 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='tf2-sku-to-name',
+    version='2.0.0',
+    author='Purple Barber',
+    description="A python library that parses TF2 item SKU to the item's name and vice versa.",
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    url='https://github.com/purplebarber/tf2-sku',
+    license='MIT',
+    packages=find_packages(),
+    install_requires=[
+        'requests'
+    ],
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    keywords="tf2, tf2-sku, team fortress 2, sku, parser",
+    python_requires='>=3.6',
+)

tf2_sku_to_name-2.0.0/sku/__init__.py

@@ -0,0 +1,13 @@
+from sku.parser import Sku, get_schema
+from sku.models import itemClass
+from sku.schema import Schema
+
+__version__ = "2.0.0"
+__all__ = ["Sku", "itemClass", "Schema", "get_schema", "update_schema"]
+
+# Main functions
+object_to_sku = Sku.object_to_sku
+sku_to_object = Sku.sku_to_object
+sku_to_name = Sku.sku_to_name
+name_to_sku = Sku.name_to_sku
+update_schema = Sku.update_schema