Metadata-Version: 2.1
Name: timechimp
Version: 0.0.5
Summary: TimeChimp API Python SDK
Home-page: https://github.com/Afilnor/TimeChimp
Author: Florian Dauphin
Author-email: dauphin.florian@gmail.com
License: UNKNOWN
Download-URL: https://github.com/Afilnor/TimeChimp/archive/refs/heads/master.zip
Description: # TimeChimp
        ![Build](https://github.com/Afilnor/TimeChimp/actions/workflows/python-publish.yml/badge.svg)
        ![License](https://img.shields.io/github/license/Afilnor/TimeChimp)
        ## Description
        - SDK to interact with TimeChimp API
        - Can return a converted response to JSON and check for errors.
        - Log HTTP method, url, params and headers
        - Hide access_token in the logs
        
        ## How to install
        `pip3 install timechimp`
        
        ## Documentation
        
        https://timechimp.readthedocs.io/en/latest/
        
        ## Source structure
        - _endpoint.py: contain the source endpoints.
        - _env_variables.py: env variables names holding the auth value (eg API token).
        - api sub-package contains the functions to call
        
        ## How to use
        
        - access token is retrieved through env variables TIMECHIMP_ACCESS_TOKEN
        
        ### Get the requests response object
        ```
        import timechimp
        
        response = timechimp.api.users.get_all()
        ```
        
        ### Convert the response object to json
        ```
        import timechimp
        
        users = timechimp.api.users.get_all(to_json=True)
        ```
        
        ## Test
        `pytest`
        
Keywords: timechimp
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
