Metadata-Version: 2.1
Name: pricestf
Version: 1.0.1
Summary: python api to Nicklason's prices.tf site.
Home-page: https://github.com/Mark7888/pricestf
Author: Mark7888
Author-email: l.mark7888@gmail.com
License: MIT
Description: # PricesTF Python API
        
        This modul is a simple python api for [Nickalson's](https://github.com/Nicklason/) prices.tf website.
        
        ### Installation
        
        This module requires [Python](https://www.python.org/) v3+ to run.
        
        For install the module type this to your command line...
        
        ```sh
        pip install pricestf
        ```
        ### Quick Example
        ```py
        from pricestf import get_price
        
        print(get_price("Scattergun", quality="Strange", australium=False, killstreak=0, error_message=True, ratelimit_data=False))
        ```
        It will return a dictionary with the item's full name and with the buy- and sellprices.
        ```json
        {'name': 'Strange Scattergun', 'buy_price': {'keys': 0, 'metal': 18.11}, 'sell_price': {'keys': 0, 'metal': 18.22}}
        ```
        If something went wring, it returns an error code.
        
        
        ##### Error codes:
        - `0`: Unknown error
        - `1`: Rate limit exceeded
        - `2`: Item is not priced
        - `3`: No prices for given source
        - `4`: No item named <name>
        
        ##### [List of tf2 items](https://wiki.alliedmods.net/Team_fortress_2_item_definition_indexes)
        &NewLine;
        ##### Qualities:
        - Normal
        - Genuine
        - Vintage
        - rarity3
        - Unusual
        - Unique (Default)
        - Community
        - Valve
        - Self-Made
        - Customized
        - Strange
        - Completed
        - Haunted
        - Collector's
        - Decorated Weapon
        
        ##### Australium:
        - It can be `True` if australium, and `False` if not. (Default: `False`)
        
        ##### Killstreak:
        - If ``not killstreak`` it's `0`
        - If ``killstreak`` it's `1`
        - If ``specialized`` it's `2`
        - If ``pofessional`` it's `3`
        
        ##### Error message:
        - If `True` it will print the error message, if `False` it wont. (Default: `True`)
        
        ##### Rate limit:
        
        If `True`, besides the prices it will even return data about the current ratelimit status. (Default: `False`)
        ```json
        {'name': 'Strange Scattergun', 'buy_price': {'keys': 0, 'metal': 18.11}, 'sell_price': {'keys': 0, 'metal': 18.22}, 'ratelimit': {'limit': 180, 'remaining': 178, 'reset': 1583686816}}
        ```
        Also usable:
        
        ```py
        from pricestf import ratelimit
        
        print(ratelimit())
        ```
        
        You will get a dictionary about the current ratelimit status.
        ```json
        {'limit': 180, 'remaining': 180, 'reset': 1583686816}
        ```
        
        License
        ----
        
        MIT
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
Requires-Python: >=3
Description-Content-Type: text/markdown
