Metadata-Version: 2.1
Name: async-lichess-sdk
Version: 1.1.0.4
Summary: Asynchronous Python API client for accessing the lichess.org API.
Home-page: https://github.com/amasend/lichees_python_SDK
Author: Amaedeusz Masny
Author-email: amadeuszmasny@gmail.com
License: Apache Software License
Description: ![Lichess Python SDK](https://github.com/amasend/lichess_python_SDK/workflows/Lichess%20Python%20SDK/badge.svg?branch=master)
        
        This package is meant to be an unofficial Python API Client for lichess.org.  
        For information about the API please refer to https://lichess.org/api  
        Every API endpoint uses async Python methods (asyncio).
        
        # Installation
        Pypi:
        `pip install async-lichess-sdk`
        
        Test Pypi:
        `pip install -i https://test.pypi.org/simple/ async-lichess-sdk`
        
        # Documentation
        `https://amasend.github.io/lichess_python_SDK/html/index.html`  
        
        # Sample Notebook
        `https://github.com/amasend/lichess_python_SDK/blob/master/sample_notebooks/How%20to%20use%20an%20Asynchronous%20Lichess%20Python%20Client.ipynb`
        
        # Dependencies
        To use this package you need to install all of the dependencies located under `requirements.txt`.  
        ```bash
        pip install requirements.txt
        ```
        Supported python versions: `python >= 3.6`
        # How to build
        Building script is located under `build.sh`.  
        Steps:  
        ```bash
        sh build.sh
        pip install -U .
        ```
        
        # Implemented Lichess Endpoints
        * account
        * boards
        * bots
        * broadcast
        * challenges
        * games
        * messages
        * relations
        * simulations
        * studies
        * teams
        * tournaments
        * users
        
        # Sample usage
        ### Client initialization and usage
        ```python
        import asyncio
        from lichess_client import APIClient
        
        
        async def main():
            client = APIClient(token="your_lichess_account_token")
            response = await client.account.get_my_profile()
            print(response)
        
        loop = asyncio.get_event_loop()
        loop.run_until_complete(main())
        
        .....
        
        {'metadata': 
            {'method': <RequestMethods.GET: 'GET'>, 
             'url': 'https://lichess.org/api/account/kid', 
             'content_type': 'application/json', 
             'timestamp': b'Fri, 13 Mar 2020 19:05:27 GMT'}, 
         'entity': 
            {'code': 200, 
             'reason': 'OK', 
             'status': <StatusTypes.SUCCESS: 'success'>, 
             'content': {'kid': False}
             }
        }
        ```
        
        ### Access to the response properties
        ```python
        
        print(response.metadata.timestamp)
        b'Fri, 13 Mar 2020 19:11:32 GMT'
        
        print(response.entity.content)
        {'kid': False}
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
