Metadata-Version: 2.1
Name: chess.com
Version: 1.5.4
Summary: Python Wrapper around Chess.com API
Home-page: https://github.com/sarartur/chess.com
Author: Artur Saradzhyan
Author-email: saradzhyanartur@gmail.com
License: UNKNOWN
Description: # Python wrapper for Chess.com Public API
        ## Description & Implementation
        Python wrapper for Chess.com API which provides public data from the chess.com website. All endpoints provided by Chess.com's API are available in the respectively named methods. 
        
        Install the package with: ```pip install chess.com``` 
        
        https://pypi.org/project/chess.com/
        ## Usage
        Please refer to https://chesscom.readthedocs.io/ and https://www.chess.com/news/view/published-data-api for documentation. Below is a simple example of the usage.
        
        All the functions return a `ChessDotComResponse` object. The data can be accessed in dictionary format or via attributes:
        ``` python
        from chessdotcom import get_player_profile
        
        response = get_player_profile("fabianocaruana")
        
        player_name = response.json['player']['name']
        #or
        player_name = response.player.name
        ```
        Optional Headers can also be set. Official Chess.com documentation recommends adding a `user-agent` header.
        ``` python
        #optional
        from chessdotcom import Client
        Client.headers = {"User-Agent": "My Python Application. Contact me at email@example.com"}
        ```
        All the methods from the module will now include the header when making the request to the API.
        
        **important**: Starting with version 1.5.0 responses from some functions have been altered in order to maintain consistent response format across all functions. All `ChessDotComResponse` objects now have 2 attributes: `json` and `{nested_object}`. The `{nested_object}` attribute contains all the data in attributes and other nested objects and is named according to what makes sense based on the returning function's name. The `json` attribute still contains the response in dictionary format, but now also has a top level key with the same name as the `{nested_object}` attribute. All functions that already return data with a top level key are unchanged.
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
